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.
- Inboxes:
-
control -> File select, file read control, framing control recvsrc
-> Block/Chunks of raw disk data
- Outboxes:
-
activatesrc -> Control messages to the file reading subsystem output
-> The framed data, payload ready
Inboxes
- ('control', '') : Code uses old style inbox/outbox
description - no metadata available
- ('recvsrc', '') : Code uses old style inbox/outbox
description - no metadata available
Outboxes
- ('output', '') : Code uses old style inbox/outbox
description - no metadata available
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, sourcename[,
sourcebitrate][, chunksize])
- Name of source - at __init__
- Data Rate - at __init__
- Chunksize - at __init__
closeDownComponent(self)
No closedown/shutdown code
handleControl(self)
returns quit flag - True means quit
handleShutdown(self)
initialiseComponent(self)
No initialisation
mainBody(self)
Loopbody:
makeChunk(self,
datatosend)
C.makeChunk(datatosend) -> chunk : network ready data
sendCurrentChunk(self[,
sendpartial])
- grab first (current chunk size) bytes
- frame chunk
- send chunk
updateTimestamp(self,
datatosend)
C.updateTimestamp(datatosend)
self.timestamp stores the timestamp of the end of the most recently
transmitted data, whenever we send some data this timestamp needs to be
updated. This method represents the calculation involved. (calculate the
time period the data covers, and increment the timestamp)
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
