g4ds.messagewrapper.ControlMessageWrapper

Package g4ds :: Module messagewrapper :: Class ControlMessageWrapper

[show private | hide private]

Class ControlMessageWrapper

GenericWrapper --+
                 |
                ControlMessageWrapper

Does exactly the same job as MessageWrapper; just for structuring purposes and extracted class for messages sent as control messages.

Inherits from MessageWrapper for allowing access to functions for hexencoding _encodeHex and hex decoding _decodeHex.

Method Summary
	`__init__(self)` Yet empty constructor.
`String`; `String`; `dict`; `String`	`unwrapSSCommunityMessage(self, message)` Extracts the action, the communityid, the tcdl and the data from a control subsystem member message xml string.
`String`; `String`; `dict`; `String`	`unwrapSSMemberMessage(self, message)` Extracts the action, the memberid, the mdl and the data from a control subsystem member message xml string.
`String`; `String`; `dict`; `String`	`unwrapSSRoutingMessage(self, message)` Extracts the information and the data from a control subsystem routing message xml string.
`String`; `String`; `dict`; `String`	`unwrapSSServiceMessage(self, message)` Extracts the information and the data from a control subsystem service message xml string.
`String`; `String`; `dict`; `String`	`unwrapSubSystemMessage(self, sstag, message)` Extracts the action, the memberid, the mdl and the data from a control subsystem member message xml string.
`String`; `xml.dom.Document`; `xml.dom.Element`	`wrapSSCommunityMessage(self, action, sucess, args, data)` Wraps a the inside of a control message for the community sub system usging the `wrapSubSystemMessage` method.
`String`; `xml.dom.Document`; `xml.dom.Element`	`wrapSSMemberMessage(self, action, sucess, args, data)` Wraps a the inside of a control message for the member sub system usging the `wrapSubSystemMessage` method.
`String`; `xml.dom.Document`; `xml.dom.Element`	`wrapSSRoutingMessage(self, action, sucess, args, data)` Wraps a the inside of a control message for the routing sub system using the `wrapSubSystemMessage` method.
`String`; `xml.dom.Document`; `xml.dom.Element`	`wrapSSServiceMessage(self, action, sucess, args, data)` Wraps a the inside of a control message for the service sub system using the `wrapSubSystemMessage` method.
`String`; `xml.dom.Document`; `xml.dom.Element`	`wrapSubSystemMessage(self, sstag, action, sucess, args, data)` Wraps a the inside of a control message for any sub system
Inherited from `GenericWrapper`: `unwrapActionAndData`, `unwrapArgsAndDatas`, `wrapActionAndData`, `wrapArgsAndDatas`

Method Details

init(self)
(Constructor)

Yet empty constructor.

Overrides:: g4ds.messagewrapper.GenericWrapper.__init__

unwrapSSCommunityMessage(self, message)

Extracts the action, the communityid, the tcdl and the data from a control subsystem member message xml string.

Inverse function to wrapSSCommunityMessage.

Parameters:: message - XML String of the control member message
(type=String)

Returns:: Action, sucess, args, data
(type=String; String; dict; String)

unwrapSSMemberMessage(self, message)

Extracts the action, the memberid, the mdl and the data from a control subsystem member message xml string.

Inverse function to wrapSSMemberMessage.

Parameters:: message - XML String of the control member message
(type=String)

Returns:: Action, sucess, args, data
(type=String; String; dict; String)

unwrapSSRoutingMessage(self, message)

Extracts the information and the data from a control subsystem routing message xml string.

Inverse function to wrapSSRoutingMessage.

Parameters:: message - XML String of the control service message
(type=String)

Returns:: Action, sucess, args, data
(type=String; String; dict; String)

Note: This wrapper is used for both routing messages and control messages for routing sub system.

unwrapSSServiceMessage(self, message)

Extracts the information and the data from a control subsystem service message xml string.

Inverse function to wrapSSServiceMessage.

Parameters:: message - XML String of the control service message
(type=String)

Returns:: Action, sucess, args, data
(type=String; String; dict; String)

unwrapSubSystemMessage(self, sstag, message)

Extracts the action, the memberid, the mdl and the data from a control subsystem member message xml string.

Inverse function to wrapSubSystemMessage.

Parameters:: sstag - Tag of the sub system as to appear in the XML file later
(type=String); message - XML String of the control member message
(type=String)

Returns:: Action, sucess, args, data
(type=String; String; dict; String)

wrapSSCommunityMessage(self, action, sucess=None, args=None, data=None)

Wraps a the inside of a control message for the community sub system usging the wrapSubSystemMessage method.

Parameters:: action - Action requested, passed to wrapSubSystemMessage
(type=String); sucess - Was the action sucessful (mainly for replies), passed to wrapSubSystemMessage
(type=String); args - Arguments to pass in form of dictionary - name | value, passed to wrapSubSystemMessage
(type=dict); data - Any additional data which does not fit into the args, passed to wrapSubSystemMessage
(type=String)

Returns:: The result as String and as Dom tree and as root element of the dom tree
(type=String; xml.dom.Document; xml.dom.Element)

wrapSSMemberMessage(self, action, sucess=None, args=None, data=None)

Wraps a the inside of a control message for the member sub system usging the wrapSubSystemMessage method.

Parameters:: action - Action requested, passed to wrapSubSystemMessage
(type=String); sucess - Was the action sucessful (mainly for replies), passed to wrapSubSystemMessage
(type=String); args - Arguments to pass in form of dictionary - name | value, passed to wrapSubSystemMessage
(type=dict); data - Any additional data which does not fit into the args, passed to wrapSubSystemMessage
(type=String)

Returns:: The result as String and as Dom tree and as root element of the dom tree
(type=String; xml.dom.Document; xml.dom.Element)

wrapSSRoutingMessage(self, action, sucess=None, args=None, data=None)

Wraps a the inside of a control message for the routing sub system using the wrapSubSystemMessage method.

Parameters:: action - Action requested, passed to wrapSubSystemMessage
(type=String); sucess - Was the action sucessful (mainly for replies), passed to wrapSubSystemMessage
(type=String); args - Arguments to pass in form of dictionary - name | value, passed to wrapSubSystemMessage
(type=dict); data - Any additional data which does not fit into the args, passed to wrapSubSystemMessage
(type=String)

Returns:: The result as String and as Dom tree and as root element of the dom tree
(type=String; xml.dom.Document; xml.dom.Element)

Note: This wrapper is used for both routing messages and control messages for routing sub system.

wrapSSServiceMessage(self, action, sucess=None, args=None, data=None)

Wraps a the inside of a control message for the service sub system using the wrapSubSystemMessage method.

Parameters:: action - Action requested, passed to wrapSubSystemMessage
(type=String); sucess - Was the action sucessful (mainly for replies), passed to wrapSubSystemMessage
(type=String); args - Arguments to pass in form of dictionary - name | value, passed to wrapSubSystemMessage
(type=dict); data - Any additional data which does not fit into the args, passed to wrapSubSystemMessage
(type=String)

Returns:: The result as String and as Dom tree and as root element of the dom tree
(type=String; xml.dom.Document; xml.dom.Element)

wrapSubSystemMessage(self, sstag, action, sucess=None, args=None, data=None)

Wraps a the inside of a control message for any sub system

Parameters:: sstag - Tag of the sub system as to appear in the XML file later
(type=String); action - Action requested
(type=String); sucess - Was the action sucessful (mainly for replies)
(type=String); args - Arguments to pass in form of dictionary - name | value
(type=dict); data - Any additional data which does not fit into the args
(type=String)

Returns:: The result as String and as Dom tree and as root element of the dom tree
(type=String; xml.dom.Document; xml.dom.Element)

Generated by Epydoc 2.0 on Sat Oct 22 22:52:47 2005

http://epydoc.sf.net