Kamaelia docs : Kamaelia.Protocol.AIM.OSCARClient.SNACExchanger

Kamaelia.Protocol.AIM.OSCARClient.SNACExchanger

For examples and more explanations, see the module level docs.


class SNACExchanger(Axon.Component.component)

SNACExchanger() -> component that has methods specialized for sending and receiving FLAPs over Channel 2 (FLAPs whose payloads are SNACs).

For a more thorough discussion on SNACs, see module level docs.

Methods defined here

__init__(self)

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

recvSnac(self)

receives FLAPs containing SNACs and parses the SNAC data.

sendSnac(self, fam, sub, body)

constructs a SNAC by calling self.makeSnac and sends it out the "outbox".

FIXME: It would be extremely helpful to have a predefined set of SNAC constants or perhaps even classes to pass to this method. For example, self.sendSnac(04, 06, data) is a lot less clear than something like self.sendSnac(MESSAGE_TO_USER, data).

waitSnac(self, fam, sub)

Yields 1 until a SNAC of the requested family and subtype is received. The last value yielded is the payload of the requested SNAC.

Usage::
for result in self.waitSnac(family, subtype): yield 1.

The body of the requested SNAC will be assigned to "result".

Feedback

Got a problem with the documentation? Something unclear that could be clearer? Want to help improve it? Constructive criticism is very welcome - especially if you can suggest a better rewording!

Please leave you feedback here in reply to the documentation thread in the Kamaelia blog.

-- Automatic documentation generator, 19 Oct 2008 at 14:29:09 UTC/GMT

This is a page from the Kamaelia website. You can find the original here: