Kamaelia docs : Kamaelia.Protocol.EchoProtocol

Simple Echo Protocol

A simple protocol component that echoes back anything sent to it.

It simply copies its input to its output.

Example Usage

A simple server that accepts connections on port 1501, echoing back anything sent to it:

>>> SimpleServer(protocol=EchoProtocol, port=1501).run()

On a unix/linux client:

> telnet <server ip> 1501
Trying <server ip>...
Connected to <server ip>...
hello world, this will be echoed back when I press return (newline)
hello world, this will be echoed back when I press return (newline)
oooh, thats nice!
oooh, thats nice!

How does it work?

The component receives data on its "inbox" inbox and immediately copies it to its "outbox" outbox.

If a producerFinished or shutdownMicroprocess message is received on its "control" inbox, the component sends a producerFinished message to its "signal" outbox and terminates.


class EchoProtocol(Axon.Component.component)

EchoProtocol() -> new EchoProtocol component

Simple component that copies anything sent to its "inbox" inbox to its "outbox" outbox.

Methods defined here


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.


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


Main body.


Return 0 if a shutdown message is received, else return 1.


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)