Revision as of 00:48, 20 July 2008 (view source) Opticron (Talk | contribs) m (→‎components?: changed the components section to info and cleaned up a little) ← Older edit		Revision as of 00:52, 20 July 2008 (view source) Opticron (Talk | contribs) (→‎info: add a comment about absolute base support of info transactions) Newer edit →
Line 39:		Line 39:
	==info==		==info==
		+	If info is implemented, it must support at least action=list, type=types, and type=actions so you can get a listing of the types and actions supported.
	===action===		===action===
	* '''list'''		* '''list'''

---

Revision as of 00:52, 20 July 2008

Contents  [hide]  1 Packet 1.1 responseid 1.2 auth 1.2.1 username 1.2.2 hash 1.3 register 1.3.1 type 1.3.2 callback 1.3.3 mime 1.4 message 1.4.1 mime 1.4.2 data 1.4.3 type 1.5 info 1.5.1 action 1.5.2 type 1.6 resource 1.6.1 type 1.6.2 action 1.6.3 results 1.7 variable 1.7.1 name 1.7.2 value 1.7.3 responseid 1.8 error 1.8.1 message

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

If info is implemented, it must support at least action=list, type=types, and type=actions so you can get a listing of the types and actions supported.

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".