Kamaelia docs : Kamaelia.Internet.UDP_ng.TargettedPeer

Kamaelia.Internet.UDP_ng.TargettedPeer

For examples and more explanations, see the module level docs.

class TargettedPeer(BasicPeer)

TargettedPeer([localaddr][,localport][,receiver_addr][,receiver_port]) -> new TargettedPeer component.

A simple component for receiving and transmitting UDP packets. It binds to the specified local address and port - from which it will receive packets and sends packets to a receiver on the specified address and port.

Can change where it is sending to by sending the new (addr,port) receiver address to the "target" inbox.

Arguments:

localaddr -- Optional. The local addresss (interface) to bind to. (default="0.0.0.0")
localport -- Optional. The local port to bind to. (default=0)
receiver_addr -- Optional. The address the receiver is bound to - to which packets will be sent. (default="0.0.0.0")
receiver_port -- Optional. The port the receiver is bound on - to which packets will be sent. (default=0)

Inboxes

control : Recieve shutdown messages
readReady : Notify that there is incoming data ready on the socket
inbox : Data to sent to the socket
writeReady : Notify that the socket is ready to send
target : Data receieved here changes the receiver addr/port data is tuple form: (host, port)

Outboxes

outbox : (data,(host,port)) tuples for each packet received
signal : Signals receiver is shutting down
_selectorSignal : For communication to the selector

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[, localaddr][, localport][, receiver_addr][, receiver_port])

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

main(self)

Main loop

Methods inherited from Kamaelia.Internet.UDP_ng.BasicPeer :

setupSelector(self)
safeBind(self, target)
sendLoop(self, target)
safeSend(self, data, target)
recvLoop(self)
safeRecv(self, size)

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)