Kamaelia docs : Kamaelia.Protocol.FortuneCookieProtocol

Simple Fortune Cookie Protocol

Simple fortune cookie protocol handler, that emits a fortune cookie (at 40 characters/second) then disconnects.

Example Usage

A simple server that accepts connections on port 1500, sending a fortune cookie to any client that connects:

>>> SimpleServer(protocol=FortuneCookieProtocol, port=1500).run()

On a unix/linux client:

> telnet <server ip> 1500
Trying <server ip>...
Connected to <server ip>...
"I love Saturday morning cartoons, what classic humour!  This is what
entertainment is all about ... Idiots, explosives and falling anvils."
                -- Calvin and Hobbes, Bill Watterson
Connection closed by foreign host.
>

How does it work?

The component gets it's data from the command "fortune -a" - the normal unix command which dumps out a random fortune cookie - read via a ReadFileAdaptor, reading from the command pipe at a constant bit rate. The ReadFileAdaptor is wired up so that data is passed through to the FortuneCookieProtocol's "outbox" outbox.

At the end of the cookie, the FortuneCookieProtocol component terminates, closing the connection (it receives and passes on the producerFinished message generated by the ReadFileAdapter component).


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)

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