Kamaelia docs : Kamaelia.Protocol.AIM.OSCARClient.OSCARProtocol

Kamaelia.Protocol.AIM.OSCARClient.OSCARProtocol

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


class OSCARProtocol(Axon.Component.component)

OSCARProtocol() -> new OSCARProtocol component.

Provides a Kamaelia interface to the lowest level of OSCAR protocol, the FLAP level.

For more information on FLAPs, see module level docs.

Inboxes

  • control : shutdown handling
  • inbox : receives binary data from the AIM server
  • talk : receives messages in the format (channel, FLAP payload)

Outboxes

  • outbox : sends binary data to the AIM server.
  • signal : shutdown handling
  • heard : resends messages from 'outbox' in the form (channel, FLAP payload)

Methods defined here

__init__(self)

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

checkBoxes(self)

checks for data in all our boxes, and if there is data, then call the appropriate function to handle it.

handleinbox(self)

receives data coming in through the wire, reformats it into a Python-friendly form, and retransmits it to its "heard" outbox.

handletalk(self)

checks that incoming messages from the "talk" inbox are in a (channel, flap data) tuple. If not, exceptions are raised. If so, OSCARProtocol.sendFLAP is called.

main(self)

main loop

sendFLAP(self, data[, channel])

constructs FLAPs and sends them

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: