April 2024 - This site, and Kamaelia are being updated. There is significant work needed, and PRs are welcome.
For examples and more explanations, see the module level docs.
PlugSplitter([sourceComponent]) -> new PlugSplitter component.
Splits incoming data out to multiple destinations. Send addsink(...)
and removesink(...) messages to the 'configuration' inbox to add and
remove destinations.
Keyword arguments:
- sourceComponent -- None, or component to act as data source
Inboxes
- control : Shutdown signalling, and signalling to be
fanned out.
- _control : Internal inbox for receiving from the
child source component (if it exists)
- configuration : addsink(...) and removesink(...)
request messages
- inbox : Data items to be fanned out.
- _inbox : Internal inbox for receiving from the
child source component (if it exists)
Outboxes
- outbox : Data items received on 'inbox' inbox.
- signal : Shutdown signalling, and data items
received on 'control' inbox.
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[,
sourceComponent])
x.__init__(...) initializes x; see x.__class__.__doc__ for
signature
_addSink(self, sink[, sinkinbox][,
sinkcontrol])
Add a new destination for data.
Specify target component (sink), and target inbox (sinkinbox) and/or
target shutdown signalling inbox (sinkcontrol).
_delSink(self, sink[, sinkinbox][,
sinkcontrol])
Remove a destination for data.
Specify target component (sink), and target inbox (sinkinbox) and/or
target shutdown signalling inbox (sinkcontrol).
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
