Kamaelia docs : Kamaelia.Protocol.Framing.DataChunker

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")

Inboxes

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

Outboxes

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

Methods defined here

__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(self)

Main loop.

shutdown(self)

Shutdown on producerFinished message arriving at "control" inbox.

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: