interface documentation

Additional functionality for multicast UDP.

Method getLoopbackMode Return if loopback mode is enabled.
Method getOutgoingInterface Return interface of outgoing multicast packets.
Method getTTL Get time to live for multicast packets.
Method joinGroup Join a multicast group. Returns Deferred of success or failure.
Method leaveGroup Leave multicast group, return Deferred of success.
Method setLoopbackMode Set if loopback mode is enabled.
Method setOutgoingInterface Set interface for outgoing multicast packets.
Method setTTL Set time to live on multicast packets.
def getLoopbackMode() -> bool: (source)

Return if loopback mode is enabled.

def getOutgoingInterface() -> str: (source)

Return interface of outgoing multicast packets.

def getTTL() -> int: (source)

Get time to live for multicast packets.

def joinGroup(addr: str, interface: str) -> Deferred[None]: (source)

Join a multicast group. Returns Deferred of success or failure.

If an error occurs, the returned Deferred will fail with error.MulticastJoinError.

def leaveGroup(addr: str, interface: str) -> Deferred[None]: (source)

Leave multicast group, return Deferred of success.

def setLoopbackMode(mode: bool): (source)

Set if loopback mode is enabled.

def setOutgoingInterface(addr: str): (source)

Set interface for outgoing multicast packets.

Returns Deferred of success.

def setTTL(ttl: int): (source)

Set time to live on multicast packets.