Kamaelia docs : Kamaelia.Util.Splitter.Plug

Kamaelia.Util.Splitter.Plug

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


class Plug(Axon.Component.component)

Plug(splitter,component) -> new Plug component.

A component that 'plugs' the specified component into the specified splitter as a destination for data.

Keyword arguments:

  • splitter -- splitter component to plug into (any component that accepts addsink(...) and removesink(...) messages on a 'configuration' inbox
  • component -- component to receive data from the splitter

Inboxes

  • control : Incoming control data for child component, and shutdown signalling
  • inbox : Incoming data for child component

Outboxes

  • outbox : Outgoing data from child component
  • signal : Outgoing control data from child component, and shutdown signalling
  • splitter_config : Used to communicate with the target splitter

Methods defined here

__init__(self, splitter, component)

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

childrenDone(self)

Unplugs any children that have terminated, and returns true if there are no running child components left (ie. their microproceses have finished)

main(self)

Main loop.

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: