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.Reading.SimpleReader

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

class SimpleReader(Axon.Component.component)

SimpleReader(filename[,mode][,buffering]) -> simple file reader

Creates a "SimpleReader" component.

Arguments:

filename -- Name of the file to read
mode -- This is the python readmode. Defaults to "r". (you may way "rb" occasionally)
buffering -- The python buffer size. Defaults to 1. (see http://www.python.org/doc/2.5.2/lib/built-in-funcs.html)

Inboxes

Outboxes

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, filename, **argd)

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

main(self)

Main loop Simply opens the file, loops through it (using "for"), sending data to "outbox". If the recipient has a maximum pipewidth it handles that eventuallity resending by pausing and waiting for the recipient to be able to recieve.

Shutsdown on shutdownMicroprocess.

shutdown(self)

Returns True if a shutdownMicroprocess message is received.

Also passes the message on out of the "signal" outbox.

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