class Client(_BaseTCPClient, BaseClient): (source)
Known subclasses: twisted.internet.ssl.Client
Constructor: Client(host, port, bindAddress, connector, reactor)
A transport for a TCP protocol; either TCPv4 or TCPv6.
Do not create these directly; use IReactorTCP.connectTCP
.
Inherited from _BaseTCPClient
:
Method | __init__ |
Undocumented |
Method | __repr__ |
Undocumented |
Method | get |
Returns an IPv4Address or IPv6Address . |
Method | get |
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 | create |
Subclasses must implement this as a method to create a python socket object of the appropriate address family and socket type. |
Instance Variable | _address |
The Twisted _IPAddress implementation for this client |
Instance Variable | _requires |
Undocumented |
Inherited from BaseClient
(via _BaseTCPClient
):
Method | do |
Initiate the outgoing connection attempt. |
Instance Variable | connected |
Undocumented |
Instance Variable | logstr |
Undocumented |
Instance Variable | protocol |
Undocumented |
Instance Variable | real |
The address object that will be used for socket.connect; this address is an address tuple (the number of elements dependent upon the address family) which does not contain any names which need to be resolved. |
Method | _collect |
Clean up references to the socket and its file descriptor. |
Method | _connect |
This is a hook for when a connection attempt has succeeded. |
Method | _stop |
Implement the POSIX-ish (i.e. twisted.internet.interfaces.IReactorFDSet ) method of detaching this socket from the reactor for _BaseBaseClient . |
Instance Variable | _base |
Connection , which is the base class of this class which has all of the useful file descriptor methods. This is used by _TLSServerMixin to call the right methods to directly manipulate the transport, as is necessary for writing TLS-encrypted bytes (whereas those methods on ... |
Inherited from _BaseBaseClient
(via _BaseTCPClient
, BaseClient
):
Method | connection |
Invoked by lower-level logic when it's time to clean the socket up. Depending on the state of the connection, either inform the attached Connector that the connection attempt has failed, or inform the connected ... |
Method | fail |
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 |
Resolve the name that was passed to this _BaseBaseClient , if necessary, and then move on to attempting the connection once an address has been determined. (The connection will be attempted immediately within this function if either name resolution can be synchronous or the address was an IP address literal... |
Method | stop |
If a connection attempt is still outstanding (i.e. no connection is yet established), immediately stop attempting to connect. |
Instance Variable | address |
The address family constant (socket.AF_INET, socket.AF_INET6, socket.AF_UNIX) of the underlying socket of this client connection. |
Instance Variable | reactor |
The class pointed to by _commonConnection should set this attribute in its constructor. |
Instance Variable | socket |
The socket type constant (socket.SOCK_STREAM or socket.SOCK_DGRAM) of the underlying socket. |
Method | _finish |
Called by subclasses to continue to the stage of initialization where the socket connect attempt is made. |
Method | _set |
Set the resolved address of this _BaseBaseClient and initiate the connection attempt. |
Class Variable | _common |
Subclasses must provide this attribute, which indicates the Connection -alike class to invoke __init__ and connectionLost on. |
Instance Variable | _close |
Subclasses must implement in order to close the socket in response to a terminated connection attempt. |
Inherited from ClientMixin
(via _BaseTCPClient
, BaseClient
, _BaseBaseClient
):
Instance Variable | _tls |
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 Connection
(via _BaseTCPClient
, BaseClient
, _BaseBaseClient
, ClientMixin
):
Method | do |
Calls self.protocol.dataReceived with all available data. |
Method | get |
Return the socket for this connection. |
Method | get |
Return if SO_KEEPALIVE is enabled. |
Method | get |
Return if TCP_NODELAY is enabled. |
Method | log |
Return the prefix to log with when I own the logging thread. |
Method | read |
Indicates read connection was lost. |
Method | set |
Enable/disable SO_KEEPALIVE. |
Method | set |
Enable/disable TCP_NODELAY. |
Method | write |
Write as much as possible of the given data to this TCP connection. |
Instance Variable | socket |
Undocumented |
Method | _close |
Undocumented |
Method | _data |
Undocumented |
Inherited from ConnectionMixin
(via _BaseTCPClient
, BaseClient
, _BaseBaseClient
, ClientMixin
, Connection
):
Method | lose |
Close this connection after writing all pending data. |
Method | register |
Register a producer. |
Method | start |
No summary |
Method | unregister |
Unregister a producer. |
Method | write |
Write some bytes to this connection, passing them through a TLS layer if necessary, or discarding them if the connection has already been lost. |
Method | write |
Write some bytes to this connection, scatter/gather-style, passing them through a TLS layer if necessary, or discarding them if the connection has already been lost. |
Constant | TLS |
A flag indicating whether TLS is currently in use on this transport. This is not a good way for applications to check for TLS, instead use twisted.internet.interfaces.ISSLTransport . |
Inherited from FileDescriptor
(via _BaseTCPClient
, BaseClient
, _BaseBaseClient
, ClientMixin
, Connection
, ConnectionMixin
):
Method | do |
Called when data can be written. |
Method | fileno |
File Descriptor number for select(). |
Method | lose |
Undocumented |
Method | pause |
Pause producing data. |
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 |
Indicates write connection was lost. |
Constant | SEND |
Undocumented |
Class Variable | buffer |
Undocumented |
Class Variable | disconnecting |
Undocumented |
Instance Variable | data |
Undocumented |
Instance Variable | disconnected |
Undocumented |
Instance Variable | offset |
Undocumented |
Instance Variable | producer |
Undocumented |
Instance Variable | producer |
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 _BaseTCPClient
, BaseClient
, _BaseBaseClient
, ClientMixin
, Connection
, ConnectionMixin
, FileDescriptor
):
Instance Variable | streaming |
bool or int |
Inherited from _LogOwner
(via _BaseTCPClient
, BaseClient
, _BaseBaseClient
, ClientMixin
, Connection
, ConnectionMixin
, FileDescriptor
, _ConsumerMixin
):
Method | _get |
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 _BaseTCPClient
, BaseClient
, _BaseBaseClient
, ClientMixin
, Connection
, ConnectionMixin
, FileDescriptor
, _ConsumerMixin
, _LogOwner
):
Instance Variable | _should |
Set to True if shutdown should be called before calling close on the underlying socket. |
Inherited from _AbortingMixin
(via _BaseTCPClient
, BaseClient
, _BaseBaseClient
, ClientMixin
, Connection
, ConnectionMixin
, FileDescriptor
, _ConsumerMixin
, _LogOwner
, _SocketCloser
):
Method | abort |
Aborts the connection immediately, dropping any buffered data. |
Instance Variable | _aborting |
Set to True when abortConnection is called. |