twisted.internet.interfaces.IListeningPort(Interface) interface documentation

Part of twisted.internet.interfaces (View In Hierarchy)

Known implementations: twisted.application.test.test_internet.FakePort, 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

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():

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():

Stop listening on this port.

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

def getHost():

Get the host that this port is listening for.

ReturnsAn IAddress provider.
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.