t.i.t.BaseClient(Connection) : class documentation

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

Known subclasses: twisted.internet.tcp.Client, twisted.internet.unix.Client

A base class for client TCP (and similiar) sockets.
Method startTLS Initiate TLS negotiation.
Method stopConnecting Stop attempt to connect.
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 createInternetSocket (internal) Create a non-blocking socket using self.addressFamily, self.socketType.
Method resolveAddress Undocumented
Method doConnect I connect the socket.
Method connectionLost See abstract.FileDescriptor.connectionLost().
Method _finishInit Called by base classes to continue to next stage of initialization.
Method _setRealAddress Undocumented
Method _connectDone Undocumented

Inherited from Connection:

Method __init__ Undocumented
Method write Reliably write some data.
Method writeSequence Reliably write a sequence of data.
Method doWrite Called when data can be written.
Method getHandle Return the socket for this connection.
Method doRead Calls self.protocol.dataReceived with all available data.
Method writeSomeData Write as much as possible of the given data to this TCP connection.
Method readConnectionLost Indicates read 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 Undocumented
Method _closeWriteConnection Undocumented

Inherited from FileDescriptor (via Connection):

Method writeConnectionLost Indicates write connection was lost.
Method loseConnection Close the connection at the next available opportunity.
Method loseWriteConnection Undocumented
Method stopReading Stop waiting for read availability.
Method stopWriting Stop waiting for write availability.
Method startReading Start waiting for read availability.
Method startWriting Start waiting for write availability.
Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.
Method stopConsuming Stop consuming data.
Method resumeProducing Undocumented
Method pauseProducing Undocumented
Method stopProducing Stop producing data.
Method fileno File Descriptor number for select().
Method _postLoseConnection Called after a loseConnection(), when all data has been written.

Inherited from _SocketCloser (via Connection):

Method _closeSocket Undocumented
def _finishInit(self, whenDone, skt, error, reactor): (source)
Called by base classes to continue to next stage of initialization.
def startTLS(self, ctx, client=1): (source)
from twisted.internet.interfaces.ITLSTransport
overrides twisted.internet.tcp.Connection.startTLS
Initiate TLS negotiation.
ParameterscontextFactoryA context factory (see ssl.py)
def stopConnecting(self): (source)
Stop attempt to connect.
def failIfNotConnected(self, err): (source)
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.
def createInternetSocket(self): (source)
(internal) Create a non-blocking socket using self.addressFamily, self.socketType.
def resolveAddress(self): (source)
Undocumented
def _setRealAddress(self, address): (source)
Undocumented
def doConnect(self): (source)

I connect the socket.

Then, call the protocol's makeConnection, and start waiting for data.
def _connectDone(self): (source)
overridden in twisted.internet.ssl.Client
Undocumented
def connectionLost(self, reason): (source)
overrides twisted.internet.tcp.Connection.connectionLost
See abstract.FileDescriptor.connectionLost().
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:17:34.