class documentation
class Port(tcp.Port): (source)
Constructor: Port(port, factory, ctxFactory, backlog, ...)
I am an SSL port.
Method | __init__ |
Initialize with a numeric port to listen on. |
Instance Variable | ctx |
Undocumented |
Method | _get |
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 |
Cleans up the socket. |
Method | create |
Undocumented |
Method | do |
Called when my socket is ready for reading. |
Method | get |
Return an IPv4Address or IPv6Address indicating the listening address of this port. |
Method | log |
Returns the name of my class, to prefix log entries with. |
Method | lose |
Stop accepting connections on this port. |
Method | start |
Create and bind my socket, and begin listening on it. |
Instance Variable | address |
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 |
Undocumented |
Instance Variable | port |
Undocumented |
Instance Variable | sessionno |
Undocumented |
Instance Variable | socket |
Undocumented |
Class Method | _from |
Create a new Port based on an existing listening SOCK_STREAM socket. |
Method | _build |
Undocumented |
Method | _log |
Log message for closing port |
Class Variable | _logger |
Undocumented |
Instance Variable | _address |
Undocumented |
Instance Variable | _preexisting |
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 |
Undocumented |
Inherited from BasePort
(via Port
):
Method | do |
Raises a RuntimeError |
Class Variable | socket |
Undocumented |
Inherited from FileDescriptor
(via Port
, BasePort
):
Method | fileno |
File Descriptor number for select(). |
Method | get |
Get the remote address of this connection. |
Method | lose |
Undocumented |
Method | pause |
Pause producing data. |
Method | read |
Indicates read connection was lost. |
Method | resume |
Resume producing data. |
Method | start |
Start waiting for read availability. |
Method | start |
Start waiting for write availability. |
Method | stop |
Stop consuming data. |
Method | stop |
Stop producing data. |
Method | stop |
Stop waiting for read availability. |
Method | stop |
Stop waiting for write availability. |
Method | write |
Reliably write some data. |
Method | write |
Indicates write connection was lost. |
Method | write |
Reliably write a sequence of data. |
Method | write |
Write as much as possible of the given data, immediately. |
Constant | SEND |
Undocumented |
Class Variable | buffer |
Undocumented |
Instance Variable | data |
Undocumented |
Instance Variable | disconnected |
Undocumented |
Instance Variable | offset |
Undocumented |
Instance Variable | producer |
Undocumented |
Instance Variable | producer |
Undocumented |
Instance Variable | reactor |
Undocumented |
Method | _close |
Undocumented |
Method | _is |
Determine whether the user-space send buffer for this transport is full or not. |
Method | _maybe |
Possibly pause a producer, if there is one and the send buffer is full. |
Method | _post |
Called after a loseConnection(), when all data has been written. |
Class Variable | _write |
Undocumented |
Instance Variable | _temp |
Undocumented |
Instance Variable | _temp |
Undocumented |
Instance Variable | _write |
Undocumented |
Inherited from _ConsumerMixin
(via Port
, BasePort
, FileDescriptor
):
Method | register |
Register to receive data from a producer. |
Method | unregister |
Stop consuming data from a producer, without disconnecting. |
Instance Variable | streaming |
bool or int |
Inherited from _SocketCloser
(via Port
, BasePort
, FileDescriptor
, _ConsumerMixin
, _LogOwner
):
Method | _close |
Undocumented |
Instance Variable | _should |
Set to True if shutdown should be called before calling close on the underlying socket. |