Go to the latest version of this document.

# ``twisted`.`internet`.`unix`.`Port``

class documentation

`class Port(_UNIXPort, tcp.Port): (source)`

Constructor: `Port(fileName, factory, backlog, mode, ...)`

View In Hierarchy

Undocumented

Method | `__init__` | Initialize with a numeric port to listen on.
Method | `__repr__` | Undocumented
Method | `connectionLost` | Cleans up the socket.
Method | `startListening` | Create and bind my socket, and begin listening on it.
Instance Variable | `connected` | Undocumented
Instance Variable | `lockFile` | Undocumented
Instance Variable | `mode` | Undocumented
Instance Variable | `numberAccepts` | Undocumented
Instance Variable | `socket` | Undocumented
Instance Variable | `wantPID` | 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 socket
Instance Variable | `_preexistingSocket` | Undocumented

Inherited from `_UNIXPort`:

Method | `getHost` | Returns a UNIXAddress.

Inherited from `Port` (via `_UNIXPort`):

Method | `createInternetSocket` | Undocumented
Method | `doRead` | Called when my socket is ready for reading.
Method | `logPrefix` | Returns the name of my class, to prefix log entries with.
Method | `loseConnection` | Stop accepting connections on this port.
Instance Variable | `addressFamily` | Undocumented
Instance Variable | `backlog` | Undocumented
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 | `port` | Undocumented
Instance Variable | `sessionno` | Undocumented
Class Variable | `_logger` | Undocumented
Instance Variable | `_addressType` | Undocumented
Instance Variable | `_realPortNumber` | Undocumented
Instance Variable | `_shouldShutdown` | 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 ...

Inherited from `BasePort` (via `_UNIXPort`, `Port`):

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

Inherited from `FileDescriptor` (via `_UNIXPort`, `Port`, `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 `_UNIXPort`, `Port`, `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 `_UNIXPort`, `Port`, `BasePort`, `FileDescriptor`, `_ConsumerMixin`):

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` (via `_UNIXPort`, `Port`, `BasePort`, `FileDescriptor`, `_ConsumerMixin`, `_LogOwner`):

Method | `_closeSocket` | Undocumented

def __init__(self, fileName, factory, backlog=50, mode=438, reactor=None, wantPID=0): (source)
overrides `twisted.internet.tcp.Port.__init__`

Initialize with a numeric port to listen on.

def __repr__(self) -> `str`: (source)
overrides `twisted.internet.tcp.Port.__repr__`

Undocumented

def connectionLost(self, reason): (source)
from `twisted.internet.interfaces.IFileDescriptor`
overrides `twisted.internet.tcp.Port.connectionLost`

Cleans up the socket.

def startListening(self): (source)
from `twisted.internet.interfaces.IListeningPort`
overrides `twisted.internet.tcp.Port.startListening`

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.

connected: `bool` = (source)
overrides `twisted.internet.tcp.Port.connected`

Undocumented

lockFile = (source)

Undocumented

mode = (source)

Undocumented

numberAccepts: `int` = (source)
overrides `twisted.internet.tcp.Port.numberAccepts`

Undocumented

socket = (source)
overrides `twisted.internet.tcp.Port.socket`

Undocumented

wantPID = (source)

Undocumented

@classmethod
def _fromListeningDescriptor(cls, reactor, fd, factory): (source)
overrides `twisted.internet.tcp.Port._fromListeningDescriptor`

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.
factory | Undocumented

Returns
A new instance of `cls` wrapping the socket given by `fd`.

def _buildAddr(self, name): (source)
overrides `twisted.internet.tcp.Port._buildAddr`

Undocumented

def _logConnectionLostMsg(self): (source)
overrides `twisted.internet.tcp.Port._logConnectionLostMsg`

Log message for closing socket

_preexistingSocket = (source)
overrides `twisted.internet.tcp.Port._preexistingSocket`

Undocumented