twisted.internet.interfaces.IMulticastTransport

interface documentation

class IMulticastTransport(Interface): (source)

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

View In Hierarchy

Additional functionality for multicast UDP.
Method get​Loopback​Mode Return if loopback mode is enabled.
Method get​Outgoing​Interface Return interface of outgoing multicast packets.
Method get​TTL Get time to live for multicast packets.
Method join​Group Join a multicast group. Returns Deferred of success or failure.
Method leave​Group Leave multicast group, return Deferred of success.
Method set​Loopback​Mode Set if loopback mode is enabled.
Method set​Outgoing​Interface Set interface for outgoing multicast packets.
Method set​TTL Set time to live on multicast packets.
def getLoopbackMode(): (source)
Return if loopback mode is enabled.
Returns
boolUndocumented
def getOutgoingInterface(): (source)
Return interface of outgoing multicast packets.
Returns
strUndocumented
def getTTL(): (source)
Get time to live for multicast packets.
Returns
intUndocumented
def joinGroup(addr, interface): (source)

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

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

Parameters
addr:strUndocumented
interface:strUndocumented
Returns
DeferredUndocumented
def leaveGroup(addr, interface): (source)
Leave multicast group, return Deferred of success.
Parameters
addr:strUndocumented
interface:strUndocumented
Returns
DeferredUndocumented
def setLoopbackMode(mode): (source)
Set if loopback mode is enabled.
Parameters
mode:boolUndocumented
def setOutgoingInterface(addr): (source)

Set interface for outgoing multicast packets.

Returns Deferred of success.

Parameters
addr:strUndocumented
def setTTL(ttl): (source)
Set time to live on multicast packets.
Parameters
ttl:intUndocumented