Kamaelia docs : 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.


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


  • 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


You should be using the inbox/outbox interface, not these methods (except construction). This documentation is designed as a roadmap as to their functionalilty for maintainers and new component developers.


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


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


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


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 loop

sendFLAP(self, data[, channel])

constructs FLAPs and sends them


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, 05 Jun 2009 at 03:01:38 UTC/GMT

Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

This is an ongoing community based development site. As a result the contents of this page is the opinions of the contributors of the pages involved not the organisations involved. Specificially, this page may contain personal views which are not the views of the BBC. (the site is powered by a wiki engine)

(C) Copyright 2008 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved.

This web site is powered by the same code created for the bicker manor project. For more details, contact Michael Sparks at BBC Research directly (cf contact)