August'24: Kamaelia is in maintenance mode and will recieve periodic updates, about twice a year,
primarily targeted around Python 3 and ecosystem compatibility.
PRs are always welcome. Latest Release: 1.14.32 (2024/3/24)
For examples and more explanations, see the module level docs.
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
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, 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, 05 Jun 2009 at 03:01:38
UTC/GMT
