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 ctx​Factory Undocumented
Method _get​Log​Prefix 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 connection​Lost Cleans up the socket.
Method create​Internet​Socket Undocumented
Method do​Read Called when my socket is ready for reading.
Method get​Host Return an IPv4Address or IPv6Address indicating the listening address of this port.
Method log​Prefix Returns the name of my class, to prefix log entries with.
Method lose​Connection Stop accepting connections on this port.
Method start​Listening Create and bind my socket, and begin listening on it.
Instance Variable address​Family 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 number​Accepts Undocumented
Instance Variable port Undocumented
Instance Variable sessionno Undocumented
Instance Variable socket Undocumented
Class Method _from​Listening​Descriptor Create a new Port based on an existing listening SOCK_STREAM socket.
Method _build​Addr Undocumented
Method _log​Connection​Lost​Msg Log message for closing port
Class Variable _logger Undocumented
Instance Variable _address​Type Undocumented
Instance Variable _preexisting​Socket 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 _real​Port​Number Undocumented

Inherited from BasePort (via Port):

Method do​Write Raises a RuntimeError
Class Variable socket​Type Undocumented

Inherited from FileDescriptor (via Port, BasePort):

Method fileno File Descriptor number for select().
Method get​Peer Get the remote address of this connection.
Method lose​Write​Connection Undocumented
Method pause​Producing Pause producing data.
Method read​Connection​Lost Indicates read connection was lost.
Method resume​Producing Resume producing data.
Method start​Reading Start waiting for read availability.
Method start​Writing Start waiting for write availability.
Method stop​Consuming Stop consuming data.
Method stop​Producing Stop producing data.
Method stop​Reading Stop waiting for read availability.
Method stop​Writing Stop waiting for write availability.
Method write Reliably write some data.
Method write​Connection​Lost Indicates write connection was lost.
Method write​Sequence Reliably write a sequence of data.
Method write​Some​Data Write as much as possible of the given data, immediately.
Constant SEND​_LIMIT Undocumented
Class Variable buffer​Size Undocumented
Instance Variable data​Buffer Undocumented
Instance Variable disconnected Undocumented
Instance Variable offset Undocumented
Instance Variable producer Undocumented
Instance Variable producer​Paused Undocumented
Instance Variable reactor Undocumented
Method _close​Write​Connection Undocumented
Method _is​Send​Buffer​Full Determine whether the user-space send buffer for this transport is full or not.
Method _maybe​Pause​Producer Possibly pause a producer, if there is one and the send buffer is full.
Method _post​Lose​Connection Called after a loseConnection(), when all data has been written.
Class Variable _write​Disconnected Undocumented
Instance Variable _temp​Data​Buffer Undocumented
Instance Variable _temp​Data​Len Undocumented
Instance Variable _write​Disconnecting Undocumented

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

Method register​Producer Register to receive data from a producer.
Method unregister​Producer Stop consuming data from a producer, without disconnecting.
Instance Variable streaming​Producer bool or int

Inherited from _SocketCloser (via Port):

Method _close​Socket Undocumented
Instance Variable _should​Shutdown Set to True if shutdown should be called before calling close on the underlying socket.
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