Difference between revisions of "Ackis2.0/Protocol"
From Makers Local 256
< Ackis2.0
m (→=type: fix title) |
(→variable: gawd...variables are going to be tricky with this new protocol, added a field into the variable message for the old ID along with constraints on usage) |
||
| Line 54: | Line 54: | ||
==variable== | ==variable== | ||
* lets a component retrieve a variable from an other component that initiated a message | * lets a component retrieve a variable from an other component that initiated a message | ||
| − | |||
===name=== | ===name=== | ||
* contains the name of the variable to be returned | * contains the name of the variable to be returned | ||
===value=== | ===value=== | ||
* contains the value of the variable to be returned | * contains the value of the variable to be returned | ||
| + | ===responseid=== | ||
| + | * the responseid that the message came in on and identifies the transaction to the core and to the initiator | ||
| + | ** the core MUST translate this forward and backward as necessary or the initiator will be unaware of the responseid | ||
| + | |||
==error== | ==error== | ||
* describes an error encountered by either the core or a component and will close the connection in most cases. | * describes an error encountered by either the core or a component and will close the connection in most cases. | ||
Revision as of 08:58, 16 July 2008
Contents[hide] |
Packet
responseid
- Typically the only attribute in the <packet> tag
- String of a reasonable length
register
- There can be more then one of these for components
type
- typically client or module or resource but not limited to such
callback
- regular expressions for messages without previous responseids
mime
- the mimetype for the types of messages that can be sent to this client.
message
mime
- the mimetype of the message, common values are:
- text/plain
- image/jpeg
data
- contents of message
type
- type of message
- targeted
- triggered
- emote
- topic
- mode
- quit
- join
- part
- none
components?
action
- list
- returns a list of all of the components of type
- type
- module or resource or something the core will have listed.
resource
type
- something like database or image
action
- something like query for the database resource or convert for the image resource
results
- rides on the responseid back to the calling component
- maybe this is just a subset of <message>s?
variable
- lets a component retrieve a variable from an other component that initiated a message
name
- contains the name of the variable to be returned
value
- contains the value of the variable to be returned
responseid
- the responseid that the message came in on and identifies the transaction to the core and to the initiator
- the core MUST translate this forward and backward as necessary or the initiator will be unaware of the responseid
error
- describes an error encountered by either the core or a component and will close the connection in most cases.
type
- describes the type of error such as "protocol" or whatever may be appropriate
message
- detailed description of the failure
- "ResponseID not found in lookup table"
- "Duplicate responseid detected"
- "Malformed XML".
