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
Method _getLogPrefix Override the normal prefix to include an annotation indicating this is a port for TLS connections.
Class Variable _type Undocumented

Inherited from Port:

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 _shouldShutdown Undocumented

Inherited from BasePort (via Port):

Method doWrite Raises a RuntimeError
Class Variable socketType Undocumented

Inherited from FileDescriptor (via 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.
Class Variable bufferSize Undocumented
Class Variable SEND_LIMIT 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.
Instance Variable _tempDataBuffer Undocumented
Instance Variable _tempDataLen Undocumented
Instance Variable _writeDisconnected Undocumented
Instance Variable _writeDisconnecting Undocumented

Inherited from _ConsumerMixin (via 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 _SocketCloser (via Port):

Method _closeSocket Undocumented
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.
_type: str = (source)

Undocumented