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)

Kamaelia.Util.RateFilter.ByteRate_RequestControl

class ByteRate_RequestControl(Axon.Component.component)

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.

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 : NOT USED

Outboxes

outbox : requests for 'n' items
signal : Shutdown signalling

Methods defined here

Warning!

init(self, rate, chunksize, chunkrate, allowchunkaggregation)

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

getChunksToSend(self)

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)

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, could be clearer? Want to help with improving? Constructive criticism, preferably in the form of suggested rewording is very welcome.

Please leave the feedback here, in reply to the documentation thread in the Kamaelia blog.