interface documentation

class twisted.internet.interfaces.IUDPTransport(Interface): (source)

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

View In Hierarchy

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): (source)

Write packet to given address.

ParameterspacketUndocumented (type: bytes)
addra 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. (type: Optional[Tuple[str, int]])
Raisestwisted.internet.error.MessageLengthErrorpacket 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.

Parametershostan IP address, not a domain name ('127.0.0.1', not 'localhost') (type: str)
portport to connect to. (type: int)
def getHost(): (source)

Get this port's host address.

Returnsan address describing the listening port. (type: Union[IPv4Address, 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.

ParametersenabledWhether the port may broadcast. (type: bool)
def getBroadcastAllowed(): (source)

Checks if broadcast is currently allowed on this port.

ReturnsWhether this port may broadcast. (type: bool)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.