April 2024 - This site, and Kamaelia are being updated. There is significant work needed, and PRs are welcome.


Intelligent File Reader

This component reads the filename specified at its creation and outputs it as several messages. When a certain number of messages in its outbox have not yet been delivered it will pause to reduce memory and CPU usage. To wake it, ideally Axon should unpause it when the outbox has less than a certain number of messages (i.e. when some are delivered) but for now you can send it an arbitrary message (to "inbox") which will wake the component.


class IntelligentFileReader(Axon.Component.component)

IntelligentFileReader(filename, chunksize, maxqueue) -> file reading component

Creates a file reader component. Reads a chunk of chunksize bytes, using the Selector to avoid having to block, pausing when the length of its send-queue exceeds maxqueue chunks.


  • control : for shutdown signalling
  • inbox : wake me up by sending anything here
  • _selectorready : ready to read


  • debug : information designed to aid debugging
  • outbox : data output
  • signal : outputs 'producerFinished' after all data has been read
  • _selectorask : ask the Selector to notify readiness to read on a file

Methods defined here


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, filename[, chunksize][, maxqueue])

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

debug(self, msg)


Main loop

makeNonBlocking(self, fd)

openFile(self, filename)

selectorWait(self, fd)

tryReadChunk(self, fd)


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