Package twisted :: Package protocols :: Module policies :: Class ProtocolWrapper
[show private | hide private]
[frames | no frames]

Class ProtocolWrapper

BaseProtocol --+    
               |    
        Protocol --+
                   |
                  ProtocolWrapper

Known Subclasses:
ThrottlingProtocol, SpewingProtocol

Wraps protocol instances and acts as their transport as well.
Method Summary
  __init__(self, factory, wrappedProtocol)
  connectionFailed(self)
(Deprecated) (inherited from Protocol)
  connectionLost(self, reason)
Called when the connection is shut down.
  connectionMade(self)
Called when a connection is made.
  dataReceived(self, data)
Called whenever data is received.
  getHost(self)
  getPeer(self)
  loseConnection(self)
  registerProducer(self, producer, streaming)
  stopConsuming(self)
  unregisterProducer(self)
  write(self, data)
  writeSequence(self, data)

Class Variable Summary
tuple __implements__
int disconnecting

Method Details

connectionLost(self, reason)

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.
Parameters:
reason
           (type=twisted.python.failure.Failure)
Overrides:
twisted.internet.protocol.Protocol.connectionLost (inherited documentation)

connectionMade(self)

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.
Overrides:
twisted.internet.protocol.BaseProtocol.connectionMade (inherited documentation)

dataReceived(self, data)

Called whenever data is received.

Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.
Parameters:
data - a string of indeterminate length. Please keep in mind that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.
Overrides:
twisted.internet.protocol.Protocol.dataReceived (inherited documentation)

Class Variable Details

__implements__

Type:
tuple
Value:
(<class twisted.internet.interfaces.ITransport at 0x81d4bcc>,)         

disconnecting

Type:
int
Value:
0                                                                      

Generated by Epydoc 1.1 on Sat Feb 15 21:18:02 2003 http://epydoc.sf.net