Revision as of 22:12, 15 July 2008 (view source) Opticron (Talk | contribs) (→‎message: added message types) ← Older edit		Revision as of 22:13, 15 July 2008 (view source) Opticron (Talk | contribs) m (→‎=type: fix title) Newer edit →
Line 21:		Line 21:
	===data===		===data===
	* contents of message		* contents of message
−	===type==	+	===type===
	* type of message		* type of message
	** targeted		** targeted

---

Revision as of 22:13, 15 July 2008

Contents  [hide]  1 Packet 1.1 responseid 1.2 register 1.2.1 type 1.2.2 callback 1.2.3 mime 1.3 message 1.3.1 mime 1.3.2 data 1.3.3 type 1.4 components? 1.4.1 action 1.5 resource 1.5.1 type 1.5.2 action 1.5.3 results 1.6 variable 1.6.1 name 1.6.2 value 1.7 error 1.7.1 type 1.7.2 message

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
• 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

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