Kamaelia docs : Kamaelia.Util.PassThrough

Passthrough of data

The PassThrough component simply passes through data from its "inbox" inbox to its "outbox" outbox.

This can be used, for example, as a dummy 'protocol' component - slotting it into a system where ordinarily a component would go that somehow changes or processes the data passing through it.

Example Usage

Creating a simple tcp socket server on port 1850 that echoes back to clients whatever they send to it:

def echoProtocol:
    return PassThrough()

SimpleServer( protocol=echoProtocol, port=1850 ).run()

More Detail

Send any item to PassThrough component's "inbox" inbox and it will immediately be sent on out of the "outbox" outbox.

If a producerFinished or shutdownMicroprocess message is received on the "control" inbox then this component will immediately terminate. It will send the message on out of its "signal" outbox. Any pending data waiting in the "inbox" inbox may be lost.


class PassThrough(Axon.Component.component)


  • control : Shutdown signalling
  • inbox : Messages to be passed through


  • outbox : Passed through messages
  • signal : Shutdown signalling

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.


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)