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.
ByteRate_RequestControl([rate][,chunksize][,chunkrate][,allowchunkaggregation])
-> new ByteRate_RequestControl component.
Controls rate of a data source by, at a controlled rate, emitting
integers saying how much data to emit. Rate can be changed at
runtime.
Keyword arguments: - rate -- qty of data items per second
(default=100000) - chunksize -- None or qty of items per 'chunk'
(default=None) - chunkrate -- None or number of chunks per second
(default=10) - allowchunkaggregation -- if True, chunksize will be
enlarged if 'catching up' is necessary (default=False)
Specify either chunksize or chunkrate, but not both.
Inboxes
- control : Shutdown signalling
- inbox : New rate
Outboxes
- outbox : requests for 'n' items
- signal : Shutdown signalling
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[,
rate][, chunksize][, chunkrate][, allowchunkaggregation])
x.__init__(...) initializes x; see x.__class__.__doc__ for
signature
changeRate(self,
newRate, now)
Change the rate.
Guaranteed to not cause a glitch in the rate of output.
getChunksToSend(self,
now)
Generator. Returns the size of chunks to be requested (if any) to
'catch up' since last time this method was called.
main(self)
Main loop.
resetTiming(self,
now)
Resets the timing variable used to determine when the next time to
send a request is.
shutdown(self)
Returns True if shutdown message received.
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
