Go to the latest version of this document.
t.i.s.Client(tcp.Client) : class documentation
Part of twisted.internet.ssl
View In Hierarchy
Inherited from _BaseTCPClient (via Client):
Inherited from BaseClient (via Client):
||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. (type:
||(internal) Create a non-blocking socket using self.addressFamily,
||Initiate the outgoing connection attempt.
which is the base class of this class which has all of the useful file
descriptor methods. This is used by
to call the right methods to directly manipulate the transport, as is
necessary for writing TLS-encrypted bytes (whereas those methods on
Server will go
through another layer of TLS if it has been enabled).
||Implement the POSIX-ish (i.e.
method of detaching this socket from the reactor for
||Clean up references to the socket and its file descriptor.
Inherited from _BaseBaseClient (via Client, BaseClient):
||The address family constant (
socket.AF_UNIX) of the
underlying socket of this client connection. (type:
||The socket type constant (
socket.SOCK_DGRAM) of the underlying socket. (type:
||The class pointed to by
_commonConnection should set this
attribute in its constructor. (type:
||Generic method called when the attemps to connect failed. It basically
cleans everything it can: call connectionFailed, stop read and write,
delete socket related members.
||If a connection attempt is still outstanding (i.e. no connection is yet
established), immediately stop attempting to connect.
||A flag indicating whether the address of this client will require name
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. (type:
||Subclasses must provide this attribute, which indicates the
class to invoke
connectionLost on. (type:
||Subclasses must implement in order to close the socket in response to a
terminated connection attempt. (type: 1-argument callable; see
||Called by subclasses to continue to the stage of initialization where
the socket connect attempt is made.
||Set the resolved address of this
and initiate the connection attempt.
Inherited from Connection (via Client, BaseClient):
Inherited from FileDescriptor (via Client, BaseClient, Connection):
Inherited from _ConsumerMixin (via Client, BaseClient, Connection, FileDescriptor):
None if no producer is registered, otherwise the registered
||A flag indicating whether the producer is currently paused. (type:
||A flag indicating whether the producer was registered as a streaming (ie
push) producer or not (ie a pull producer). This will determine whether
the consumer may ever need to pause and resume it, or if it can merely call
resumeProducing on it when buffer space is available.
||Register to receive data from a producer.
||Stop consuming data from a producer, without disconnecting.
Inherited from _LogOwner (via Client, BaseClient, Connection, FileDescriptor):
Inherited from _SocketCloser (via Client, BaseClient, Connection):
Inherited from _AbortingMixin (via Client, BaseClient, Connection):
||Aborts the connection immediately, dropping any buffered data.
abortConnection is called. (type:
provider which this descriptor will use to get readable and writeable event
notifications. If no value is given, the global reactor will be used.
API Documentation for Twisted, generated by pydoctor at 2013-11-08 22:07:30.
This is a hook for when a connection attempt has succeeded.
Here, we build the protocol from the
that was passed in, compute a log string, begin reading so as to send
traffic to the newly built protocol, and finally hook up the protocol
This hook is overridden by
initiate the TLS protocol.