Package twisted :: Package flow :: Module protocol :: Class _Protocol
[show private | hide private]
[frames | no frames]

Class _Protocol

         Controller --+
                      |
Instruction --+       |
              |       |
          Stage --+   |
                  |   |
           Callback --+
                      |
   BaseProtocol --+   |
                  |   |
           Protocol --+
                      |
                     _Protocol


A concrete flow.Protocol for inheritance
Method Summary
  __init__(self)
  __call__(self, result)
called by the producer to indicate a successful result (inherited from Callback)
  __iter__(self)
(inherited from Stage)
  connectionFailed(self)
(Deprecated) (inherited from Protocol)
  connectionLost(self, reason)
Called when the connection is shut down.
  connectionMade(self)
Called when a connection is made.
  controller(protocol)
  dataReceived(self, data)
Called whenever data is received. (inherited from Protocol)
  errback(self, fail)
called by the producer in case of Failure (inherited from Callback)
  finish(self)
called by producer to indicate successful stream completion (inherited from Callback)
  makeConnection(self, transport)
Make a connection to a transport and a server. (inherited from BaseProtocol)
  next(self)
return current result (inherited from Stage)
  result(self, result)
called by the producer to indicate a successful result (inherited from Callback)
  _execute(self, dummy)
  _yield(self)
executed during a yield statement by previous stage (inherited from Callback)

Class Variable Summary
int finishOnConnectionLost

Method Details

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

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)

Class Variable Details

finishOnConnectionLost

Type:
int
Value:
1                                                                      

Generated by Epydoc 1.1 on Fri Jun 27 03:49:21 2003 http://epydoc.sf.net