Kamaelia docs : Kamaelia.Util.RateFilter.ByteRate_RequestControl

Kamaelia.Util.RateFilter.ByteRate_RequestControl

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


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

__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 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: