Difference between revisions of "Ackis2.0/Protocol"
From Makers Local 256
< Ackis2.0
(initial commit) |
(→Packet: add a provision for reporting errors of various types, also add in a tag for variable retrieval from the originator) |
||
| Line 40: | Line 40: | ||
* rides on the responseid back to the calling component | * rides on the responseid back to the calling component | ||
* maybe this is just a subset of <message>s? | * maybe this is just a subset of <message>s? | ||
| + | |||
| + | ==variable== | ||
| + | * lets a component retrieve a variable from an other component that initiated a message | ||
| + | * utilizes the same responseid that the originating message came in on? | ||
| + | ===name=== | ||
| + | * contains the name of the variable to be returned | ||
| + | ===value=== | ||
| + | * contains the value of the variable to be returned | ||
| + | ==error== | ||
| + | This tag exists to describe errors encountered by either the core or a component and will typically close the connection. | ||
| + | ===type=== | ||
| + | This describes the type of error such as "protocol" or whatever may be appropriate. | ||
| + | ===message=== | ||
| + | This gives a more detailed description of the failure, such as "ResponseID not found in lookup table", "Duplicate responseid detected", or "Malformed XML". | ||
Revision as of 22:41, 10 July 2008
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
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
- utilizes the same responseid that the originating message came in on?
name
- contains the name of the variable to be returned
value
- contains the value of the variable to be returned
error
This tag exists to describe errors encountered by either the core or a component and will typically close the connection.
type
This describes the type of error such as "protocol" or whatever may be appropriate.
message
This gives a more detailed description of the failure, such as "ResponseID not found in lookup table", "Duplicate responseid detected", or "Malformed XML".
