Kamaelia.Protocol.FortuneCookieProtocol.FortuneCookieProtocol

class FortuneCookieProtocol(Axon.Component.component)

FortuneCookieProtocol([debug]) -> new FortuneCookieProtocol component.

A protocol that spits out a random fortune cookie, then terminates.

Keyword arguments: - debug -- Debugging output control (default=0)

Inboxes

control : Secondary inbox often used for signals. The closest analogy is unix signals
inbox : Default inbox for bulk data. Used in a pipeline much like stdin

Outboxes

outbox : Default data out outbox, used in a pipeline much like stdout
signal : The default signal based outbox - kinda like stderr, but more for sending singal type signals

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, debug)

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

initialiseComponent(self)

Initialises component. Sets up a ReadFileAdapter to read the result of running 'fortune'.

mainBody(self)

Main body.

All the interesting work has been done by linking the file reader's output to our output. Messages sent to control are unchecked and the first message causes the component to exit.

Feedback

Got a problem with the documentation? Something unclear, could be clearer? Want to help with improving? Constructive criticism, preferably in the form of suggested rewording is very welcome.

Please leave the feedback here, in reply to the documentation thread in the Kamaelia blog.

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)