Difference between revisions of "Ackis2.0/Protocol"
From Makers Local 256
< Ackis2.0
m (→auth: formatting tweak) |
m (→components?: changed the components section to info and cleaned up a little) |
||
Line 38: | Line 38: | ||
** none | ** none | ||
− | == | + | ==info== |
===action=== | ===action=== | ||
* '''list''' | * '''list''' | ||
** returns a list of all of the components of '''type''' | ** returns a list of all of the components of '''type''' | ||
− | + | ===type=== | |
− | + | * '''module''' or '''resource''' or something the core will have listed. | |
==resource== | ==resource== |
Revision as of 00:48, 20 July 2008
Packet
responseid
- Typically the only attribute in the <packet> tag
- String of a reasonable length
auth
username
- the username, duh
hash
- this is a md5 hash of the username concatenated with the responseid and password in that order
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
info
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.
message
- detailed description of the failure
- "ResponseID not found in lookup table"
- "Duplicate responseid detected"
- "Malformed XML".