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.File.TriggeredFileReader

Triggered File Reader

This component accepts a filepath as an "inbox" message, and outputs the contents of that file to "outbox". All requests are processed sequentially.

This component does not terminate.

Drawback - this component uses blocking file reading calls but does not run on its own thread.


Kamaelia.File.TriggeredFileReader.TriggeredFileReader

class TriggeredFileReader(Axon.Component.component)

TriggeredFileReader() -> component that reads arbitrary files

Inboxes

  • control : Shut me down
  • inbox : filepaths to read

Outboxes

  • outbox : file contents, 1 per message
  • signal : Signal my shutdown with producerFinished

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)

main(self)

Main loop

readFile(self, filename)

Read data out of a file

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