twisted.internet.tcp.Port

class documentation

class Port(base.BasePort, _SocketCloser): (source)

Known subclasses: twisted.internet.ssl.Port, twisted.internet.unix.Port

Implements interfaces: twisted.internet.interfaces.IListeningPort

A TCP server port, listening for connections.

When a connection is accepted, this will call a factory's buildProtocol with the incoming address as an argument, according to the specification described in twisted.internet.interfaces.IProtocolFactory.

If you wish to change the sort of transport that will be used, the transport attribute will be called with the signature expected for Server.__init__, so it can be replaced.

Method	`__init__`	Initialize with a numeric port to listen on.
Method	`__repr__`	Undocumented
Method	`connectionLost`	Cleans up the socket.
Method	`createInternetSocket`	Undocumented
Method	`doRead`	Called when my socket is ready for reading.
Method	`getHost`	Return an `IPv4Address` or `IPv6Address` indicating the listening address of this port.
Method	`logPrefix`	Returns the name of my class, to prefix log entries with.
Method	`loseConnection`	Stop accepting connections on this port.
Method	`startListening`	Create and bind my socket, and begin listening on it.
Instance Variable	`addressFamily`	Undocumented
Instance Variable	`backlog`	Undocumented
Instance Variable	`connected`	flag set once the listen has successfully been called on the socket.
Instance Variable	`deferred`	a deferred created when `stopListening` is called, and that will fire when connection is lost. This is not to be used it directly: prefer the deferred returned by `stopListening` instead.
Instance Variable	`disconnecting`	flag indicating that the `stopListening` method has been called and that no connections should be accepted anymore.
Instance Variable	`factory`	Undocumented
Instance Variable	`interface`	Undocumented
Instance Variable	`numberAccepts`	Undocumented
Instance Variable	`port`	Undocumented
Instance Variable	`sessionno`	Undocumented
Instance Variable	`socket`	Undocumented
Class Method	`_fromListeningDescriptor`	Create a new `Port` based on an existing listening SOCK_STREAM socket.
Method	`_buildAddr`	Undocumented
Method	`_logConnectionLostMsg`	Log message for closing port
Class Variable	`_logger`	Undocumented
Instance Variable	`_addressType`	Undocumented
Instance Variable	`_preexistingSocket`	If not `None`, a `socket.socket` instance which was created and initialized outside of the reactor and will be used to listen for connections (instead of a new socket being created by this `Port`).
Instance Variable	`_realPortNumber`	Undocumented
Instance Variable	`_type`	A string describing the connections which will be created by this port. Normally this is `"TCP"`, since this is a TCP port, but when the TLS implementation re-uses this class it overrides the value with `"TLS"`. Only used for logging.

Inherited from BasePort:

Method	`doWrite`	Raises a RuntimeError
Class Variable	`socketType`	Undocumented

Inherited from FileDescriptor (via BasePort):

Method	`fileno`	File Descriptor number for select().
Method	`getPeer`	Get the remote address of this connection.
Method	`loseWriteConnection`	Undocumented
Method	`pauseProducing`	Pause producing data.
Method	`readConnectionLost`	Indicates read connection was lost.
Method	`resumeProducing`	Resume producing data.
Method	`startReading`	Start waiting for read availability.
Method	`startWriting`	Start waiting for write availability.
Method	`stopConsuming`	Stop consuming data.
Method	`stopProducing`	Stop producing data.
Method	`stopReading`	Stop waiting for read availability.
Method	`stopWriting`	Stop waiting for write availability.
Method	`write`	Reliably write some data.
Method	`writeConnectionLost`	Indicates write connection was lost.
Method	`writeSequence`	Reliably write a sequence of data.
Method	`writeSomeData`	Write as much as possible of the given data, immediately.
Constant	`SEND_LIMIT`	Undocumented
Class Variable	`bufferSize`	Undocumented
Instance Variable	`dataBuffer`	Undocumented
Instance Variable	`disconnected`	Undocumented
Instance Variable	`offset`	Undocumented
Instance Variable	`producer`	Undocumented
Instance Variable	`producerPaused`	Undocumented
Instance Variable	`reactor`	Undocumented
Method	`_closeWriteConnection`	Undocumented
Method	`_isSendBufferFull`	Determine whether the user-space send buffer for this transport is full or not.
Method	`_maybePauseProducer`	Possibly pause a producer, if there is one and the send buffer is full.
Method	`_postLoseConnection`	Called after a loseConnection(), when all data has been written.
Class Variable	`_writeDisconnected`	Undocumented
Instance Variable	`_tempDataBuffer`	Undocumented
Instance Variable	`_tempDataLen`	Undocumented
Instance Variable	`_writeDisconnecting`	Undocumented

Inherited from _ConsumerMixin (via BasePort, FileDescriptor):

Method	`registerProducer`	Register to receive data from a producer.
Method	`unregisterProducer`	Stop consuming data from a producer, without disconnecting.
Instance Variable	`streamingProducer`	`bool` or `int`

Inherited from _LogOwner (via BasePort, FileDescriptor):

Method _getLogPrefix Determine the log prefix to use for messages related to applicationObject, which may or may not be an interfaces.ILoggingContext provider.

Inherited from _SocketCloser:

Method	`_closeSocket`	Undocumented
Instance Variable	`_shouldShutdown`	Set to `True` if `shutdown` should be called before calling `close` on the underlying socket.

def __init__(self, port, factory, backlog=50, interface='', reactor=None): (source)

overrides twisted.internet.abstract.FileDescriptor.__init__

overridden in twisted.internet.ssl.Port, twisted.internet.unix.Port

Initialize with a numeric port to listen on.

def __repr__(self): (source)

overridden in twisted.internet.unix.Port

Undocumented

Returns
`str`	Undocumented

def connectionLost(self, reason): (source)

from twisted.internet.interfaces.IFileDescriptor

overrides twisted.internet.abstract.FileDescriptor.connectionLost

overridden in twisted.internet.unix.Port

Cleans up the socket.

def createInternetSocket(self): (source)

overrides twisted.internet.base.BasePort.createInternetSocket

Undocumented

def doRead(self): (source)

from twisted.internet.interfaces.IReadDescriptor

overrides twisted.internet.abstract.FileDescriptor.doRead

Called when my socket is ready for reading.

This accepts a connection and calls self.protocol() to handle the wire-level protocol.

def getHost(self): (source)

from twisted.internet.interfaces.IListeningPort

overrides twisted.internet.abstract.FileDescriptor.getHost

Return an IPv4Address or IPv6Address indicating the listening address of this port.

def logPrefix(self): (source)

from twisted.internet.interfaces.ILoggingContext

overrides twisted.internet.abstract._LogOwner.logPrefix

Returns the name of my class, to prefix log entries with.

def loseConnection(self, connDone=failure.Failure(main.CONNECTION_DONE)): (source)

from twisted.internet.interfaces.ITransport

overrides twisted.internet.abstract.FileDescriptor.loseConnection

Stop accepting connections on this port.

This will shut down the socket and call self.connectionLost(). It returns a deferred which will fire successfully when the port is actually closed, or with a failure if an error occurs shutting down.

def startListening(self): (source)

from twisted.internet.interfaces.IListeningPort

overridden in twisted.internet.unix.Port

Create and bind my socket, and begin listening on it.

This is called on unserialization, and must be called after creating a server to begin listening on the specified port.

addressFamily = (source)

overrides twisted.internet.base.BasePort.addressFamily

Undocumented

backlog = (source)

Undocumented

connected: bool = (source)

overrides twisted.internet.abstract.FileDescriptor.connected

overridden in twisted.internet.unix.Port

flag set once the listen has successfully been called on the socket.

deferred: defer.Deferred = (source)

a deferred created when stopListening is called, and that will fire when connection is lost. This is not to be used it directly: prefer the deferred returned by stopListening instead.

disconnecting: bool = (source)

overrides twisted.internet.abstract.FileDescriptor.disconnecting

flag indicating that the stopListening method has been called and that no connections should be accepted anymore.

factory = (source)

Undocumented

interface = (source)

Undocumented

numberAccepts: int = (source)

overridden in twisted.internet.unix.Port

Undocumented

port = (source)

Undocumented

sessionno = (source)

Undocumented

socket = (source)

overridden in twisted.internet.unix.Port

Undocumented

@classmethod
def _fromListeningDescriptor(cls, reactor, fd, addressFamily, factory): (source)

overridden in twisted.internet.unix.Port

Create a new Port based on an existing listening SOCK_STREAM socket.

Arguments are the same as to Port.__init__, except where noted.

Parameters
reactor	Undocumented
fd	An integer file descriptor associated with a listening socket. The socket must be in non-blocking mode. Any additional attributes desired, such as FD_CLOEXEC, must also be set already.
addressFamily	The address family (sometimes called domain) of the existing socket. For example, `socket.AF_INET`.
factory	Undocumented
Returns
A new instance of `cls` wrapping the socket given by `fd`.

def _buildAddr(self, address): (source)

overridden in twisted.internet.unix.Port

Undocumented

def _logConnectionLostMsg(self): (source)

overridden in twisted.internet.unix.Port

Log message for closing port

_logger = (source)

Undocumented

_addressType = (source)

Undocumented

_preexistingSocket = (source)

overridden in twisted.internet.unix.Port

If not None, a socket.socket instance which was created and initialized outside of the reactor and will be used to listen for connections (instead of a new socket being created by this Port).

_realPortNumber = (source)

Undocumented

_type: str = (source)

overridden in twisted.internet.ssl.Port

A string describing the connections which will be created by this port. Normally this is "TCP", since this is a TCP port, but when the TLS implementation re-uses this class it overrides the value with "TLS". Only used for logging.