Kamaelia

Nuts & Bolts | Components | Tools | Cookbook | Systems
wiki:( guest720099, Dev Console, Index, Recent, Edit )


Home, News
Dev Console

How, Why
Project Blog
Summer of Code

Documentation
Download
SVN (web)
Sourceforge page

Project Admin
License

Contact Us

  Page Tags

No tags are defined for this page yet - how would you classify/think of this page? Add your notes below!

Kamaelia docs : Kamaelia.Util.Collate

Collate everything received into a single message

Buffers all data sent to it. When shut down, sends all data it has received as collated as a list in a single message.

Example Usage

Read a file, in small chunks, then collate them into a single chunk:

Pipeline( RateControlledFileReader("big_file", ... ),
          Collate(),
          ...
        )

Behaviour

Send data items to its "inbox" inbox to be collated.

Send a producerFinished or shutdownMicroprocess message to the "control" inbox to terminate this component.

All collated data items will be sent out of the "outbox" outbox as a list in a single message. The items are collated in the same order they first arrived.

The component will then send on the shutdown message to its "signal" outbox and immediately terminate.


Kamaelia.Util.Collate.Collate

class Collate(Axon.Component.component)

Collate() -> new Collate component.

Buffers all data sent to it. When shut down, sends all data it has received as a single message.

Inboxes

  • control : Shutdown signalling
  • inbox : Data items

Outboxes

  • outbox : All data items collated into one message
  • signal : Shutdown signalling

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.

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, 20 Jul 2008 at 03:02:36 UTC/GMT


Your tags for this page: If you had set UserPreferences (name & email) and validated them (simple single click in your email), you would be able to define personal tags

Versions: current , 1


(C) 2005 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.