March 2024 - This site, and Kamaelia are being updated. There is significant work needed, and PRs are welcome.

Kamaelia.Util.ChunkNamer

Chunk Namer

A component that labels each message with a unique filename for that message. e.g. "A" ... "B" ... --> ["chunk1", "A"] ... ["chunk2", "B"] ...

Example Usage

Save each line entered to the console to a separate file:

pipeline(
    ConsoleReader(),
    ChunkNamer("test", ".txt"),
    WholeFileWriter()
).run()

Kamaelia.Util.ChunkNamer.ChunkNamer

class ChunkNamer(Axon.Component.component)

ChunkNamer() -> new ChunkNamer component.

Gives a filename to the chunk and sends it in the form [filename, contents], e.g. to a WholeFileWriter component.

Keyword arguments: -- basepath - the prefix to apply to the filename -- suffix - the suffix to apply to the filename

Inboxes

  • control : Shut me down
  • inbox : Chunks to be saved

Outboxes

  • outbox : List: [file name, file contents]
  • signal : signal when I've shut down

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

main(self)

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