August'24: Kamaelia is in maintenance mode and will recieve periodic updates, about twice a year,
primarily targeted around Python 3 and ecosystem compatibility.
PRs are always welcome. Latest Release: 1.14.32 (2024/3/24)
For examples and more explanations, see the module level docs.
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
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.
__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, 05 Jun 2009 at 03:01:38
UTC/GMT
