twisted.internet.interfaces.IListeningPort

interface documentation

class IListeningPort(Interface): (source)

Known implementations: twisted.internet.iocpreactor.tcp.Port, twisted.internet.iocpreactor.udp.Port, twisted.internet.tcp.Port, twisted.internet.udp.Port, twisted.pair.tuntap.TuntapPort, twisted.internet.testing._FakePort

View In Hierarchy

A listening port.

Method getHost Get the host that this port is listening for.
Method startListening Start listening on this port.
Method stopListening Stop listening on this port.
def getHost() -> IAddress: (source)

Get the host that this port is listening for.

Returns
IAddressAn IAddress provider.
def startListening(): (source)

Start listening on this port.

Raises
CannotListenErrorIf it cannot listen on this port (e.g., it is a TCP port and it cannot bind to the required port number).
def stopListening() -> Optional[Deferred[None]]: (source)

Stop listening on this port.

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