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

Type Server

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

Known Subclasses:
PassableServerConnection, Server

Serverside socket-stream connection class.

I am a serverside network connection transport; a socket which came from an accept() on a server.
Method Summary
  __init__(self, sock, protocol, client, server, sessionno)
Server(sock, protocol, client, server, sessionno)
  __repr__(self)
A string representation of this connection.
  getHost(self)
Returns an IPv4Address.
  getPeer(self)
Returns an IPv4Address.
  startTLS(self, ctx, server)
    Inherited from Connection
  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)
  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 can be written.
  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)
Reliably write a sequence of data.
    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
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Class Variable Summary
Implements __implemented__ = <implementedBy twisted.internet.tcp.Se...
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...
    Inherited from Connection
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

__init__(self, sock, protocol, client, server, sessionno)
(Constructor)

Server(sock, protocol, client, server, sessionno)

Initialize me with a socket, a protocol, a descriptor for my peer (a tuple of host, port describing the other end of the connection), an instance of Port, and a session number.
Overrides:
twisted.internet.tcp.Connection.__init__

__repr__(self)
(Representation operator)

A string representation of this connection.
Overrides:
__builtin__.object.__repr__

getHost(self)

Returns an IPv4Address.

This indicates the server's address.

getPeer(self)

Returns an IPv4Address.

This indicates the client's address.

Class Variable Details

__implemented__

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

__provides__

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

Generated by Epydoc 2.1 on Fri Feb 2 11:44:39 2007 http://epydoc.sf.net