Kamaelia docs : Kamaelia.File.Writing.SimpleFileWriter

Kamaelia.File.Writing.SimpleFileWriter

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

class SimpleFileWriter(Axon.Component.component)

SimpleFileWriter(filename) -> component that writes data to the file

Writes any data sent to its inbox to the specified file.

Inboxes

control : to receive shutdown/finished messages
inbox : data to write to file

Outboxes

outbox : not used
signal : shutdown/finished signalling

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

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

closeDownComponent(self)

Closes the file handle

main(self)

Main loop

shutdown(self)

Returns True if a shutdownMicroprocess or producerFinished message is received.

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

writeData(self, data)

Writes the data to the 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, 12 Oct 2008 at 03:01:28 UTC/GMT

(C) 2005 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved,
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.