class documentation

class Client(_BaseBaseClient, _BaseTCPClient, Connection): (source)

View In Hierarchy

Method __init__ Undocumented
Method cb​Connect Undocumented
Method create​Internet​Socket Create a socket registered with the IOCP reactor.
Method do​Connect Undocumented
Instance Variable reactor Undocumented
Method _collect​Socket​Details Clean up potentially circular references to the socket and to its getFileHandle method.
Method _stop​Reading​And​Writing Remove the active handle from the reactor.
Instance Variable _tls​Client​Default Always True, indicating that this is a client connection, and by default when TLS is negotiated this class will act as a TLS client.

Inherited from _BaseBaseClient:

Method connection​Lost No summary
Method fail​If​Not​Connected Generic method called when the attempts to connect failed. It basically cleans everything it can: call connectionFailed, stop read and write, delete socket related members.
Method resolve​Address No summary
Method stop​Connecting If a connection attempt is still outstanding (i.e. no connection is yet established), immediately stop attempting to connect.
Instance Variable address​Family The address family constant (socket.AF_INET, socket.AF_INET6, socket.AF_UNIX) of the underlying socket of this client connection.
Instance Variable real​Address Undocumented
Instance Variable socket​Type The socket type constant (socket.SOCK_STREAM or socket.SOCK_DGRAM) of the underlying socket.
Method _finish​Init Called by subclasses to continue to the stage of initialization where the socket connect attempt is made.
Method _set​Real​Address Set the resolved address of this _BaseBaseClient and initiate the connection attempt.
Class Variable _common​Connection Subclasses must provide this attribute, which indicates the Connection-alike class to invoke __init__ and connectionLost on.
Instance Variable _close​Socket Subclasses must implement in order to close the socket in response to a terminated connection attempt.
Instance Variable _requires​Resolution A flag indicating whether the address of this client will require name resolution. True if the hostname of said address indicates a name that must be resolved by hostname lookup, False if it indicates an IP address literal.

Inherited from _BaseTCPClient:

Method __repr__ Undocumented
Method get​Host Returns an IPv4Address or IPv6Address.
Method get​Peer Returns an IPv4Address or IPv6Address.
Instance Variable addr The address that this socket will be connecting to.
Instance Variable connector The Connector which is driving this _BaseTCPClient's connection attempt.
Instance Variable _address​Type The Twisted _IPAddress implementation for this client
Instance Variable _requires​Resolution Undocumented

Inherited from Connection:

Method connection​Lost The connection was lost.
Method data​Received
Method get​Handle Return a system- and reactor-specific handle.
Method get​Host Returns IPv4Address or IPv6Address.
Method get​Peer Returns IPv4Address or IPv6Address.
Method get​Tcp​Keep​Alive Return if SO_KEEPALIVE is enabled.
Method get​Tcp​No​Delay Return if TCP_NODELAY is enabled.
Method log​Prefix Return the prefix to log with when I own the logging thread.
Method lose​Connection Close the underlying handle or, if TLS has been started, first shut it down.
Method read​Connection​Lost Indicates read connection was lost.
Method read​From​Handle Read into the given buffers from this handle.
Method register​Producer Register a producer.
Method set​Tcp​Keep​Alive Enable/disable SO_KEEPALIVE.
Method set​Tcp​No​Delay Enable/disable TCP_NODELAY.
Method start​TLS
Method unregister​Producer Unregister a producer.
Method write Write some data, either directly to the underlying handle or, if TLS has been started, to the TLSMemoryBIOProtocol for it to encrypt and send.
Method write​Sequence Write some data, either directly to the underlying handle or, if TLS has been started, to the TLSMemoryBIOProtocol for it to encrypt and send.
Method write​To​Handle Send buff to current file handle using _iocp.send. The buffer sent is limited to a size of self.SEND_LIMIT.
Constant TLS False to indicate the connection is in normal TCP mode, True to indicate that TLS has been started and that operations must be routed through the TLSMemoryBIOProtocol instance.
Instance Variable protocol Undocumented
Instance Variable socket Undocumented
Method _close​Write​Connection Undocumented

Inherited from FileHandle (via Connection):

Method do​Read Undocumented
Method do​Write Undocumented
Method get​File​Handle Undocumented
Method lose​Write​Connection Undocumented
Method pause​Producing Pause producing data.
Method resume​Producing Resume producing data.
Method start​Reading Undocumented
Method start​Writing No summary
Method stop​Consuming Stop consuming data.
Method stop​Producing Stop producing data.
Method stop​Reading Undocumented
Method stop​Writing Undocumented
Method write​Connection​Lost Indicates write connection was lost.
Constant SEND​_LIMIT Undocumented
Class Variable disconnecting Undocumented
Class Variable dynamic​Read​Buffers Undocumented
Class Variable logstr Undocumented
Class Variable max​Read​Buffers Undocumented
Class Variable read​Buffer​Size Undocumented
Class Variable write​Buffer​Size Undocumented
Instance Variable connected 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 reading Undocumented
Instance Variable writing Undocumented
Method _cb​Read Undocumented
Method _cb​Write Undocumented
Method _dispatch​Data Dispatch previously read data. Return True if self.reading and we don't have any more data
Method _handle​Read Returns False if we should stop reading for now
Method _handle​Write Returns false if we should stop writing for now
Method _resume​Reading Undocumented
Method _resume​Writing Undocumented
Class Variable _write​Disconnected Undocumented
Instance Variable _read​Buffers Undocumented
Instance Variable _read​Next​Buffer Undocumented
Instance Variable _read​Scheduled Undocumented
Instance Variable _read​Scheduled​In​OS Undocumented
Instance Variable _read​Size Undocumented
Instance Variable _temp​Data​Buffer Undocumented
Instance Variable _temp​Data​Len Undocumented
Instance Variable _write​Disconnecting Undocumented
Instance Variable _write​Scheduled Undocumented

Inherited from _ConsumerMixin (via Connection, FileHandle):

Instance Variable streaming​Producer bool or int

Inherited from _LogOwner (via Connection, FileHandle):

Method _get​Log​Prefix 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 Connection):

Method _close​Socket Undocumented
Instance Variable _should​Shutdown Set to True if shutdown should be called before calling close on the underlying socket.

Inherited from _AbortingMixin (via Connection):

Method abort​Connection Aborts the connection immediately, dropping any buffered data.
Instance Variable do​Read Undocumented
Instance Variable do​Write Undocumented
Instance Variable _aborting Set to True when abortConnection is called.
def __init__(self, host, port, bindAddress, connector, reactor): (source)
def cbConnect(self, rc, data, evt): (source)

Undocumented

def createInternetSocket(self): (source)
Create a socket registered with the IOCP reactor.
See Also
_BaseTCPClient
def doConnect(self): (source)

Undocumented

def _collectSocketDetails(self): (source)
Clean up potentially circular references to the socket and to its getFileHandle method.
See Also
_BaseBaseClient
def _stopReadingAndWriting(self): (source)
Remove the active handle from the reactor.
See Also
_BaseBaseClient
_tlsClientDefault: bool = (source)
Always True, indicating that this is a client connection, and by default when TLS is negotiated this class will act as a TLS client.