April 2024 - This site, and Kamaelia are being updated. There is significant work needed, and PRs are welcome.


Simple multicast receiver

A simple component for receiving packets in the specified multicast group.

Remember that multicast is an unreliable connection - packets may be lost, duplicated or reordered.

Example Usage

Receiving multicast packets from group address port 1000 and displaying them on the console:

Pipeline( Multicast_receiver("", 1000),

The data emitted by Multicast_receiver (and displayed by ConsoleEchoer) is of the form (source_address, data).

More detail

Data received from the multicast group is emitted as a tuple: (source_addr, data) where data is a string of the received data.

This component ignores anything received on its "control" inbox. It is not yet possible to ask it to shut down. It does not terminate.

Multicast groups do not 'shut down', so this component never emits any signals on its "signal" outbox.


class Multicast_receiver(Axon.Component.component)

Multicast_receiver(address, port) -> component that receives multicast traffic.

Creates a component that receives multicast packets in the given multicast group and sends it out of its "outbox" outbox.

Keyword arguments:

  • address -- address of multicast group (string)
  • port -- port number


  • control : NOT USED
  • inbox : NOT USED


  • outbox : Emits (src_addr, data_received)
  • signal : NOT USED

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.

__init__(self, address, port)

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


Main loop


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