Kamaelia docs : Kamaelia.Protocol.Framing.DataChunker


For examples and more explanations, see the module level docs.

class DataChunker(Axon.Component.component)

DataChunker([syncmessage]) -> new DataChunker component.

Delineates messages by prefixing them with a 'sync' sequence, allowing a receiver to synchronise to the chunks in the stream. Any occurrences of the sequence within the message itself are escaped to prevent misinterpretation.

Keyword arguments:

  • syncmessage -- string to use as 'sync' sequence (default="XXXXXXXXXXXXXXXXXXXXXXXX")


  • control : shutdown messages (producerFinished)
  • inbox : message strings to be chunked


  • outbox : chunked message strings
  • signal : producerFinished shutdown messages

Methods defined here


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[, syncmessage])

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

encodeChunk(self, message)

Returns the message with the 'sync' message prefix and escaping done.

escapeSyncMessage(self, message)

Returns the message, with occurrences of 'sync' message escaped.


Main loop.


Shutdown on producerFinished message arriving at "control" inbox.


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

Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

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. (the site is powered by a wiki engine)

(C) Copyright 2008 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved.

This web site is powered by the same code created for the bicker manor project. For more details, contact Michael Sparks at BBC Research directly (cf contact)