twisted.internet.tcp.Client

Inherited from _BaseTCPClient:

Method	__init__	Undocumented
Method	__repr__	Undocumented
Method	getHost	Returns an IPv4Address or IPv6Address.
Method	getPeer	Returns an IPv4Address or IPv6Address.
Instance Variable	addr	The address that this socket will be connecting to.
Instance Variable	addressFamily	Undocumented
Instance Variable	connector	The Connector which is driving this _BaseTCPClient's connection attempt.
Instance Variable	createInternetSocket	Subclasses must implement this as a method to create a python socket object of the appropriate address family and socket type.
Instance Variable	_addressType	The Twisted _IPAddress implementation for this client
Instance Variable	_requiresResolution	Undocumented

Inherited from BaseClient (via _BaseTCPClient):

Method	doConnect	Initiate the outgoing connection attempt.
Instance Variable	connected	Undocumented
Instance Variable	logstr	Undocumented
Instance Variable	protocol	Undocumented
Instance Variable	realAddress	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	_collectSocketDetails	Clean up references to the socket and its file descriptor.
Method	_connectDone	This is a hook for when a connection attempt has succeeded.
Method	_stopReadingAndWriting	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	connectionLost	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	failIfNotConnected	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	resolveAddress	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	stopConnecting	If a connection attempt is still outstanding (i.e. no connection is yet established), immediately stop attempting to connect.
Instance Variable	reactor	The class pointed to by _commonConnection should set this attribute in its constructor.
Instance Variable	socketType	The socket type constant (socket.SOCK_STREAM or socket.SOCK_DGRAM) of the underlying socket.
Method	_finishInit	Called by subclasses to continue to the stage of initialization where the socket connect attempt is made.
Method	_setRealAddress	Set the resolved address of this _BaseBaseClient and initiate the connection attempt.
Class Variable	_commonConnection	Subclasses must provide this attribute, which indicates the Connection-alike class to invoke __init__ and connectionLost on.
Instance Variable	_closeSocket	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

_tlsClientDefault

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	doRead	Calls self.protocol.dataReceived with all available data.
Method	getHandle	Return the socket for this connection.
Method	getTcpKeepAlive	Return if SO_KEEPALIVE is enabled.
Method	getTcpNoDelay	Return if TCP_NODELAY is enabled.
Method	logPrefix	Return the prefix to log with when I own the logging thread.
Method	readConnectionLost	Indicates read connection was lost.
Method	setTcpKeepAlive	Enable/disable SO_KEEPALIVE.
Method	setTcpNoDelay	Enable/disable TCP_NODELAY.
Method	writeSomeData	Write as much as possible of the given data to this TCP connection.
Instance Variable	socket	Undocumented
Method	_closeWriteConnection	Undocumented
Method	_dataReceived	Undocumented

Inherited from ConnectionMixin (via _BaseTCPClient, BaseClient, _BaseBaseClient, ClientMixin, Connection):

Method	loseConnection	Close this connection after writing all pending data.
Method	registerProducer	Register a producer.
Method	startTLS	No summary
Method	unregisterProducer	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	writeSequence	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	doWrite	Called when data can be written.
Method	fileno	File Descriptor number for select().
Method	loseWriteConnection	Undocumented
Method	pauseProducing	Pause producing data.
Method	resumeProducing	Resume producing data.
Method	startReading	Start waiting for read availability.
Method	startWriting	Start waiting for write availability.
Method	stopConsuming	Stop consuming data.
Method	stopProducing	Stop producing data.
Method	stopReading	Stop waiting for read availability.
Method	stopWriting	Stop waiting for write availability.
Method	writeConnectionLost	Indicates write connection was lost.
Constant	SEND_LIMIT	Undocumented
Class Variable	bufferSize	Undocumented
Class Variable	disconnecting	Undocumented
Instance Variable	dataBuffer	Undocumented
Instance Variable	disconnected	Undocumented
Instance Variable	offset	Undocumented
Instance Variable	producer	Undocumented
Instance Variable	producerPaused	Undocumented
Method	_isSendBufferFull	Determine whether the user-space send buffer for this transport is full or not.
Method	_maybePauseProducer	Possibly pause a producer, if there is one and the send buffer is full.
Method	_postLoseConnection	Called after a loseConnection(), when all data has been written.
Class Variable	_writeDisconnected	Undocumented
Instance Variable	_tempDataBuffer	Undocumented
Instance Variable	_tempDataLen	Undocumented
Instance Variable	_writeDisconnecting	Undocumented

Inherited from _ConsumerMixin (via _BaseTCPClient, BaseClient, _BaseBaseClient, ClientMixin, Connection, ConnectionMixin, FileDescriptor):

Instance Variable

streamingProducer

bool or int

Inherited from _LogOwner (via _BaseTCPClient, BaseClient, _BaseBaseClient, ClientMixin, Connection, ConnectionMixin, FileDescriptor, _ConsumerMixin):

Method

_getLogPrefix

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

_shouldShutdown

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	abortConnection	Aborts the connection immediately, dropping any buffered data.
Instance Variable	_aborting	Set to True when abortConnection is called.