t.i.i.IUDPTransport(Interface) : interface documentation

Part of twisted.internet.interfaces View Source View In Hierarchy

Known implementations: twisted.internet.iocpreactor.udp.Port

Transport for UDP DatagramProtocols.

Method	write	Write packet to given address.
Method	connect	Connect the transport to an address.
Method	getHost	Get this port's host address.
Method	stopListening	Stop listening on this port.
Method	setBroadcastAllowed	Set whether this port may broadcast.
Method	getBroadcastAllowed	Checks if broadcast is currently allowed on this port.

def write(packet, addr=None): (source)

Write packet to given address.

Parameters	addr	a tuple of (ip, port). For connected transports must be the address the transport is connected to, or None. In non-connected mode this is mandatory.
Raises	twisted.internet.error.MessageLengthError	`packet` was too long.

def connect(host, port): (source)

Connect the transport to an address.

This changes it to connected mode. Datagrams can only be sent to this address, and will only be received from this address. In addition the protocol's connectionRefused method might get called if destination is not receiving datagrams.

Parameters	host	an IP address, not a domain name ('127.0.0.1', not 'localhost')
	port	port to connect to.

def getHost(): (source)

Get this port's host address.

Returns an address describing the listening port. (type: IPv4Address or IPv6Address.)

def stopListening(): (source)

Stop listening on this port.

If it does not complete immediately, will return Deferred that fires upon completion.

def setBroadcastAllowed(enabled): (source)

Set whether this port may broadcast.

Parameters enabled Whether the port may broadcast. (type: bool)

def getBroadcastAllowed(): (source)

Checks if broadcast is currently allowed on this port.

Returns Whether this port may broadcast. (type: bool)

API Documentation for Twisted, generated by pydoctor at 2014-05-12 18:27:00.