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

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: