Kamaelia.Util.PipelineComponent.pipeline

class pipeline(Axon.Component.component)

pipeline(*components) -> new pipeline component.

Encapsulates the specified set of components and wires them up in a chain (a pipeline) in the order you provided them.

Arguments: - components - the components you want, in the order you want them wired up

Inboxes

control : Secondary inbox often used for signals. The closest analogy is unix signals
inbox : Default inbox for bulk data. Used in a pipeline much like stdin

Outboxes

outbox : Default data out outbox, used in a pipeline much like stdout
signal : The default signal based outbox - kinda like stderr, but more for sending singal type signals

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

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, could be clearer? Want to help with improving? Constructive criticism, preferably in the form of suggested rewording is very welcome.

Please leave the feedback here, in reply to the documentation thread in the Kamaelia blog.

(C) 2006 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved, 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.