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

Type Connection

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

Known Subclasses:
BaseClient, Server

I am the superclass of all socket-based FileDescriptors.

This is an abstract superclass of all objects which represent a TCP/IP connection based socket.
Method Summary
  __init__(self, skt, protocol, reactor)
  connectionLost(self, reason)
See abstract.FileDescriptor.connectionLost().
  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)
  startTLS(self, ctx)
  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
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.abstract.FileDescriptor.connectionLost

doRead(self)

Calls self.protocol.dataReceived with all available data.

This reads up to self.bufferSize bytes of data from its socket, then calls self.dataReceived(data) to process it. If the connection is not lost through an error in the physical recv(), this function will return the result of the dataReceived call.
Overrides:
twisted.internet.abstract.FileDescriptor.doRead

getHandle(self)

Return the socket for this connection.

logPrefix(self)

Return the prefix to log with when I own the logging thread.
Overrides:
twisted.python.log.Logger.logPrefix

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)
Overrides:
twisted.internet.abstract.FileDescriptor.writeSomeData

Class Variable Details

__implemented__

Type:
Implements
Value:
<implementedBy twisted.internet.tcp.Connection>                        

__provides__

Type:
ClassProvides
Value:
<zope.interface.declarations.ClassProvides object at 0xf737ed4c>       

logstr

Type:
str
Value:
'Uninitialized'                                                        

TLS

Type:
int
Value:
0                                                                     

Generated by Epydoc 2.1 on Sun Oct 26 16:38:51 2008 http://epydoc.sf.net