Kamaelia docs : Kamaelia.File.Append

Append

This component accepts data from it's inbox "inbox" and appends the data to the end of the given file.

It takes four arguments, with these default values:

filename = None
forwarder = True
blat_file = False
hold_open = True

filename should be clear. If you don't supply this, it'll break.

forwarder - this component defaults to passing on a copy of the data it's appending to the file. This makes this component useful for dropping in between other components for logging/debugging what's going on.

blat_file - if this is true, the file is zapped before we start appending data.

hold_open - This determines if the file is closed between instances of data arriving.


Kamaelia.File.Append.Append

class Append(Axon.Component.component)

Appender() -> component that incrementally append data to the end of a file (think logging)

Uses the following keyword argyments:

* filename - File to append to (required)
* forwarder - copy to outbox (default: True)
* blat_file - write empty file (default: False)
* hold_open - keep file open (default: True)

Inboxes

  • control : Send any message here to shut this component down
  • inbox : data to append to the end of the file.

Outboxes

  • outbox : a copy of the message is forwarded here
  • signal : passes on the message used to shutdown the component

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

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

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)