Kamaelia docs : Kamaelia.Visualisation.PhysicsGraph.chunks_to_lines

Text line splitter

This component takes chunks of text and splits them at line breaks into individual lines.

Example usage

A system that connects to a server and receives fragmented text data, but then displays it a whole line at a time:

Pipeline( TCPClient(host=..., port=...),
  chunks_to_lines(),
  ConsoleEcho()
).run()

How does it work?

chunks_to_lines buffers all text it receives on its "inbox" inbox. If there is a line break ("n") in the text it has buffered, then it extracts that line of text, including the line break character and sends it on out of its "outbox" outbox.

It also removes any "r" characters in the text.

If a producerFinished() or shutdownMicroprocess() message is received on this component's "control" inbox, then it will send it on out of its "signal" outbox and immediately terminate. It will not flush any whole lines of text that may still be buffered.


Kamaelia.Visualisation.PhysicsGraph.chunks_to_lines.chunks_to_lines

class chunks_to_lines(Axon.Component.component)

chunks_to_lines() -> new chunks_to_lines component.

Takes in chunked textual data and splits it at line breaks into individual lines.

Inboxes

  • control : Shutdown signalling
  • inbox : Chunked textual data

Outboxes

  • outbox : Individual lines of text
  • signal : Shutdown 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.

main(self)

Main loop.

shutdown(self)

Returns True if a shutdownMicroprocess or producerFinished message was received.

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)