Kamaelia docs : Kamaelia.File.Reading.PromptedFileReader

Kamaelia.File.Reading.PromptedFileReader

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


class PromptedFileReader(Axon.Component.component)

PromptedFileReader(filename[,readmode]) -> file reading component

Creates a file reader component. Reads N bytes/lines from the file when N is sent to its inbox.

Keyword arguments:

  • readmode -- "bytes" or "lines"

Inboxes

  • control : for shutdown signalling
  • inbox : requests to 'n' read bytes/lines

Outboxes

  • outbox : data output
  • signal : outputs 'producerFinished' after all data has been read

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[, readmode])

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

closeDownComponent(self)

Closes the file handle

main(self)

Main loop

readNBytes(self, n)

readNBytes(n) -> string containing 'n' bytes read from the file.

"EOF" raised if the end of the file is reached and there is no data to return.

readNLines(self, n)

readNLines(n) -> string containing 'n' lines read from the file.

"EOF" raised if the end of the file is reached and there is no data to return.

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


Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

This is an ongoing community based development site. As a result the contents of this page is the opinions of the contributors of the pages involved not the organisations involved. Specificially, this page may contain personal views which are not the views of the BBC. (the site is powered by a wiki engine)

(C) Copyright 2008 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved.

This web site is powered by the same code created for the bicker manor project. For more details, contact Michael Sparks at BBC Research directly (cf contact)