Package twisted :: Package internet :: Module tcp :: Class BaseClient
[show private | hide private]
[frames | no frames]

Type BaseClient

 Ephemeral --+        
             |        
    Logger --+        
             |        
    object --+        
             |        
FileDescriptor --+    
                 |    
 _SocketCloser --+    
                 |    
        Connection --+
                     |
                    BaseClient

Known Subclasses:
Client

A base class for client TCP (and similiar) sockets.
Method Summary
  connectionLost(self, reason)
See abstract.FileDescriptor.connectionLost().
  createInternetSocket(self)
(internal) Create a non-blocking socket using self.addressFamily, self.socketType.
  doConnect(self)
I connect the socket.
  failIfNotConnected(self, err)
  resolveAddress(self)
  startTLS(self, ctx, client)
  stopConnecting(self)
Stop attempt to connect.
    Inherited from Connection
  __init__(self, skt, protocol, reactor)
  doRead(self)
Calls self.protocol.dataReceived with all available data.
  getHandle(self)
Return the socket for this connection.
  getTcpKeepAlive(self)
  getTcpNoDelay(self)
  logPrefix(self)
Return the prefix to log with when I own the logging thread.
  readConnectionLost(self, reason)
  setTcpKeepAlive(self, enabled)
  setTcpNoDelay(self, enabled)
  writeSomeData(self, data)
Connection.writeSomeData(data) -> #of bytes written | CONNECTION_LOST This writes as much data as possible to the socket and returns either the number of bytes read (which is positive) or a connection error code (which is negative)
    Inherited from FileDescriptor
  doWrite(self)
Called when data is available for writing.
  fileno(self)
File Descriptor number for select().
  loseConnection(self, _connDone)
Close the connection at the next available opportunity.
  loseWriteConnection(self)
  pauseProducing(self)
  registerProducer(self, producer, streaming)
Register to receive data from a producer.
  resumeProducing(self)
  startReading(self)
Start waiting for read availability.
  startWriting(self)
Start waiting for write availability.
  stopConsuming(self)
Stop consuming data.
  stopProducing(self)
  stopReading(self)
Stop waiting for read availability.
  stopWriting(self)
Stop waiting for write availability.
  unregisterProducer(self)
Stop consuming data from a producer, without disconnecting.
  write(self, data)
Reliably write some data.
  writeConnectionLost(self, reason)
  writeSequence(self, iovec)
    Inherited from Ephemeral
  __getstate__(self)
  __setstate__(self, state)
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Class Variable Summary
int addressFamily = 2                                                                     
int socketType = 1                                                                     
    Inherited from Connection
Implements __implemented__ = <implementedBy twisted.internet.tcp.Co...
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...
str logstr = 'Uninitialized'
int TLS = 0                                                                     
    Inherited from FileDescriptor
int bufferSize = 65536                                                                 
int connected = 0                                                                     
str dataBuffer = ''
int disconnected = 0                                                                     
int disconnecting = 0                                                                     
int offset = 0                                                                     
NoneType producer = None                                                                  
int producerPaused = 0                                                                     
int SEND_LIMIT = 131072                                                                
int streamingProducer = 0                                                                     
    Inherited from Logger
ClassProvides __providedBy__ = <zope.interface.declarations.ClassProvi...

Method Details

connectionLost(self, reason)

See abstract.FileDescriptor.connectionLost().
Overrides:
twisted.internet.tcp.Connection.connectionLost (inherited documentation)

createInternetSocket(self)

(internal) Create a non-blocking socket using self.addressFamily, self.socketType.

doConnect(self)

I connect the socket.

Then, call the protocol's makeConnection, and start waiting for data.

stopConnecting(self)

Stop attempt to connect.

Class Variable Details

addressFamily

Type:
int
Value:
2                                                                     

socketType

Type:
int
Value:
1                                                                     

Generated by Epydoc 2.1 on Mon Jul 30 18:00:09 2007 http://epydoc.sf.net