twisted.internet.interfaces.IMulticastTransport : API documentation

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

def getOutgoingInterface(): (source)

Return interface of outgoing multicast packets.

Returns Undocumented (type: str)

def setOutgoingInterface(addr): (source)

Set interface for outgoing multicast packets.

Returns Deferred of success.

Parameters addr Undocumented (type: str)

def getLoopbackMode(): (source)

Return if loopback mode is enabled.

Returns Undocumented (type: bool)

def setLoopbackMode(mode): (source)

Set if loopback mode is enabled.

Parameters mode Undocumented (type: bool)

def getTTL(): (source)

Get time to live for multicast packets.

Returns Undocumented (type: int)

def setTTL(ttl): (source)

Set time to live on multicast packets.

Parameters ttl Undocumented (type: int)

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.

def leaveGroup(addr, interface): (source)

Leave multicast group, return Deferred of success.