Home       Trees       Index       Help   
Package twisted :: Package internet :: Module protocol :: Class Protocol
[show private | hide private]
[frames | no frames]

Class Protocol

BaseProtocol --+
               |
              Protocol

Known Subclasses:
TwistedConnection
Method Summary
  connectionLost(self, reason)
Called when the connection is shut down.
  dataReceived(self, data)
Called whenever data is received.

Class Variable Summary
Implements __implemented__ = <implementedBy twisted.internet.protoc...
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...

Method Details

connectionLost(self, reason=<twisted.python.failure.Failure twisted.internet.error.Co...) 

Called when the connection is shut down.

Clear any circular references here, and any external references
to this Protocol.  The connection has been closed.

@type reason: L{twisted.python.failure.Failure}

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.

@param 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.

Class Variable Details

__implemented__

Type:
Implements
Value:
<implementedBy twisted.internet.protocol.Protocol>

__provides__

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

   Home       Trees       Index       Help   
Generated by Epydoc 2.1 on Fri Jan 1 08:00:26 2010 http://epydoc.sf.net