t.i.i.t.Client(_BaseBaseClient, _BaseTCPClient, Connection) : class documentation

Part of twisted.internet.iocpreactor.tcp View Source View In Hierarchy

Method __init__ Undocumented
Method createInternetSocket Create a socket registered with the IOCP reactor.
Method cbConnect Undocumented
Method doConnect Undocumented
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.
Method _collectSocketDetails Clean up potentially circular references to the socket and to its getFileHandle method.
Method _stopReadingAndWriting Remove the active handle from the reactor.

Inherited from _BaseBaseClient:

Instance Variable addressFamily The address family constant (socket.AF_INET, socket.AF_INET6, socket.AF_UNIX) of the underlying socket of this client connection. (type: int)
Instance Variable socketType The socket type constant (socket.SOCK_STREAM or socket.SOCK_DGRAM) of the underlying socket. (type: int)
Instance Variable reactor The class pointed to by _commonConnection should set this attribute in its constructor. (type: twisted.internet.interfaces.IReactorTime, twisted.internet.interfaces.IReactorCore, twisted.internet.interfaces.IReactorFDSet)
Method resolveAddress No summary
Method failIfNotConnected 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.
Method stopConnecting If a connection attempt is still outstanding (i.e. no connection is yet established), immediately stop attempting to connect.
Method connectionLost No summary
Instance Variable _requiresResolution 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. (type: bool)
Class Variable _commonConnection Subclasses must provide this attribute, which indicates the Connection-alike class to invoke __init__ and connectionLost on. (type: type)
Instance Variable _closeSocket Subclasses must implement in order to close the socket in response to a terminated connection attempt. (type: 1-argument callable; see _SocketCloser._closeSocket)
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.

Inherited from _BaseTCPClient:

Instance Variable connector The Connector which is driving this _BaseTCPClient's connection attempt.
Instance Variable addr The address that this socket will be connecting to. (type: If IPv4, a 2-tuple of (str host, int port). If IPv6, a 4-tuple of (str host, int port, int ignored, int scope).)
Method getHost Returns an IPv4Address or IPv6Address.
Method getPeer Returns an IPv4Address or IPv6Address.
Method __repr__ Undocumented
Instance Variable _addressType The Twisted _IPAddress implementation for this client (type: IPv4Address or IPv6Address)

Inherited from Connection:

Instance Variable 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.
Method getHandle Return a system- and reactor-specific handle.
Method dataReceived Undocumented
Method readFromHandle Undocumented
Method writeToHandle Send buff to current file handle using _iocp.send. The buffer sent is limited to a size of self.SEND_LIMIT.
Method readConnectionLost Indicates read connection was lost.
Method connectionLost The connection was lost.
Method logPrefix Return the prefix to log with when I own the logging thread.
Method getTcpNoDelay Return if TCP_NODELAY is enabled.
Method setTcpNoDelay Enable/disable TCP_NODELAY.
Method getTcpKeepAlive Return if SO_KEEPALIVE is enabled.
Method setTcpKeepAlive Enable/disable SO_KEEPALIVE.
Method startTLS
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 writeSequence 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 loseConnection Close the underlying handle or, if TLS has been started, first shut it down.
Method registerProducer Register a producer.
Method unregisterProducer Unregister a producer.
Method _closeWriteConnection Undocumented

Inherited from FileHandle (via Connection):

Method startReading Undocumented
Method stopReading Undocumented
Method doRead Undocumented
Method loseWriteConnection Undocumented
Method writeConnectionLost Indicates write connection was lost.
Method startWriting No summary
Method stopWriting Undocumented
Method doWrite Undocumented
Method getFileHandle Undocumented
Method stopConsuming Stop consuming data.
Method resumeProducing Resume producing data.
Method pauseProducing Pause producing data.
Method stopProducing Undocumented
Method _resumeReading Undocumented
Method _dispatchData Dispatch previously read data. Return True if self.reading and we don't have any more data
Method _cbRead Undocumented
Method _handleRead Returns False if we should stop reading for now
Method _resumeWriting Undocumented
Method _cbWrite Undocumented
Method _handleWrite Returns false if we should stop writing for now

Inherited from _ConsumerMixin (via Connection, FileHandle):

Instance Variable producer None if no producer is registered, otherwise the registered producer.
Instance Variable producerPaused A flag indicating whether the producer is currently paused. (type: bool or int)
Instance Variable streamingProducer 0 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.
Instance Variable streamingProducer bool or int

Inherited from _LogOwner (via Connection, FileHandle):

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 Connection):

Method _closeSocket Undocumented

Inherited from _AbortingMixin (via Connection):

Method abortConnection Aborts the connection immediately, dropping any buffered data.
Instance Variable _aborting Set to True when abortConnection is called. (type: bool)
_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.
def __init__(self, host, port, bindAddress, connector, reactor): (source)
Undocumented
def createInternetSocket(self): (source)
Create a socket registered with the IOCP reactor.
See Also_BaseTCPClient
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
def cbConnect(self, rc, bytes, evt): (source)
Undocumented
def doConnect(self): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2013-11-18 18:11:01.