class documentation

class Port(tcp.Port): (source)

View In Hierarchy

I am an SSL port.

Method __init__ Initialize with a numeric port to listen on.
Instance Variable ctxFactory Undocumented
Class Variable _type Undocumented
Method _getLogPrefix Override the normal prefix to include an annotation indicating this is a port for TLS connections.

Inherited from Port:

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 connected flag set once the listen has successfully been called on the socket.
Instance Variable sessionno Undocumented
Instance Variable interface Undocumented
Instance Variable backlog Undocumented
Instance Variable port Undocumented
Instance Variable factory Undocumented
Instance Variable addressFamily Undocumented
Method __repr__ Undocumented
Method createInternetSocket Undocumented
Method startListening Create and bind my socket, and begin listening on it.
Instance Variable socket Undocumented
Instance Variable numberAccepts Undocumented
Method doRead Called when my socket is ready for reading.
Method loseConnection Stop accepting connections on this port.
Method connectionLost Cleans up the socket.
Method logPrefix Returns the name of my class, to prefix log entries with.
Method getHost Return an IPv4Address or IPv6Address indicating the listening address of this port.
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
Class Variable _logger Undocumented
Instance Variable _addressType Undocumented
Class Method _fromListeningDescriptor Create a new Port based on an existing listening SOCK_STREAM socket.
Instance Variable _shouldShutdown Undocumented
Method _buildAddr Undocumented
Method _logConnectionLostMsg Log message for closing port

Inherited from BasePort (via Port):

Class Variable socketType Undocumented
Method doWrite Raises a RuntimeError

Inherited from FileDescriptor (via Port, BasePort):

Instance Variable disconnected Undocumented
Instance Variable dataBuffer Undocumented
Instance Variable offset Undocumented
Class Variable SEND_LIMIT Undocumented
Instance Variable reactor Undocumented
Instance Variable producer Undocumented
Method writeSomeData Write as much as possible of the given data, immediately.
Instance Variable producerPaused Undocumented
Method writeConnectionLost Indicates write connection was lost.
Method readConnectionLost Indicates read connection was lost.
Method getPeer Get the remote address of this connection.
Method write Reliably write some data.
Method writeSequence Reliably write a sequence of data.
Method loseWriteConnection Undocumented
Method stopReading Stop waiting for read availability.
Method stopWriting Stop waiting for write availability.
Method startReading Start waiting for read availability.
Method startWriting Start waiting for write availability.
Class Variable bufferSize Undocumented
Method stopConsuming Stop consuming data.
Method resumeProducing Resume producing data.
Method pauseProducing Pause producing data.
Method stopProducing Stop producing data.
Method fileno File Descriptor number for select().
Instance Variable _writeDisconnecting Undocumented
Instance Variable _writeDisconnected Undocumented
Instance Variable _tempDataBuffer Undocumented
Instance Variable _tempDataLen Undocumented
Method _postLoseConnection Called after a loseConnection(), when all data has been written.
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.

Inherited from _ConsumerMixin (via Port, BasePort, FileDescriptor):

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

Inherited from _SocketCloser (via Port):

Method _closeSocket Undocumented
_type = (source)

Undocumented

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

Initialize with a numeric port to listen on.

ctxFactory = (source)

Undocumented

def _getLogPrefix(self, factory): (source)

Override the normal prefix to include an annotation indicating this is a port for TLS connections.

API Documentation for Twisted, generated by pydoctor 21.2.0 at 2021-02-28 21:00:42.