Kamaelia docs : Kamaelia.Protocol.Framing.DataDeChunker

Kamaelia.Protocol.Framing.DataDeChunker

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


class DataDeChunker(Axon.Component.component)

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

Synchronises to a stream of string data, delimited into chunks by a 'sync' sequence. Chunks are buffered until the next 'sync sequence is received and are then passed on.

Keyword arguments:

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

Inboxes

  • control : shutdown messages (producerFinished)
  • inbox : partial message chunk strings
  • flush : instructions to flush the internal buffer

Outboxes

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

Methods defined here

__init__(self[, syncmessage])

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

decodeChunk(self, chunk)

unEscape and return the chunk, sans the 'sync' sequence prefix, or raise IncompleteChunk if the chunk isn't prefixed with the 'sync' sequence (can't guarantee the chunk is whole).

main(self)

Main loop.

shouldFlush(self)

Returns non-zero if a message has been received on the "flush" inbox

shutdown(self)

Shutdown on producerFinished message arriving at "control" inbox.

unEscapeSyncMessage(self, message)

Returns message with escaped occurrences of the 'sync' message unescaped again.

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: