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.testing._FakePort, twisted.internet.udp.Port, twisted.pair.tuntap.TuntapPort

View In Hierarchy

A listening port.

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

Start listening on this port.

RaisesCannotListenErrorIf it cannot listen on this port (e.g., it is a TCP port and it cannot bind to the required port number).
def stopListening(): (source)

Stop listening on this port.

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

ReturnsUndocumented (type: Optional[Deferred])
def getHost(): (source)

Get the host that this port is listening for.

ReturnsAn IAddress provider. (type: IAddress)
API Documentation for Twisted, generated by pydoctor 21.2.2 at 2021-06-04 02:13:44.