Kamaelia docs : Kamaelia.Util.Splitter.Splitter

Kamaelia.Util.Splitter.Splitter

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

class Splitter(Axon.AdaptiveCommsComponent.AdaptiveCommsComponent)

Splitter() -> new Splitter component.

Splits incoming data out to multiple destinations. Send addsink(...) and removesink(...) messages to the 'configuration' inbox to add and remove destinations.

Inboxes

control : NOT USED
configuration : addsink(...) and removesink(...) request messages
inbox : Source of data items

Outboxes

outbox : NOT USED
signal : NOT USED

Methods defined here

Warning!

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.

init(self)

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

createsink(self, sink[, sinkbox][, passthrough])

Set up a new destination for data.

Creates an outbox, links it to the target (component,inbox) and records it in self.outlist.

deletesink(self, oldsink)

Removes the specified (component, inbox) as a destination for data where (component, inbox) = (oldsink.sink, oldsink.sinkbox).

Unlinks the target, destroys the corresponding outbox, and removes the corresponding record from self.outlist.

mainBody(self)

Main loop body.

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, 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)