Package twisted :: Package protocols :: Module ftp :: Class SenderProtocol
[show private | hide private]
[frames | no frames]

Class SenderProtocol

BaseProtocol --+    
               |    
        Protocol --+
                   |
                  SenderProtocol


Method Summary
  __init__(self)
  connectionFailed(self)
(Deprecated) (inherited from Protocol)
  connectionLost(self, reason)
Called when the connection is shut down.
  connectionMade(self)
Called when a connection is made. (inherited from BaseProtocol)
  dataReceived(self, data)
Called whenever data is received.
  finish(self)
  makeConnection(self, transport)
Make a connection to a transport and a server.
  registerProducer(self)
  unregisterProducer(self)
  write(self, data)

Class Variable Summary
tuple __implements__

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)

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)

makeConnection(self, transport)

Make a connection to a transport and a server.

This sets the 'transport' attribute of this Protocol, and calls the connectionMade() callback.
Overrides:
twisted.internet.protocol.BaseProtocol.makeConnection (inherited documentation)

Class Variable Details

__implements__

Type:
tuple
Value:
(<class twisted.internet.interfaces.IProtocol at 0x8243ddc>,
 <class twisted.internet.interfaces.IFinishableConsumer at 0x821e954>) 

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