Package twisted :: Package conch :: Package ssh :: Module session :: Class SSHSessionProtocol
[frames | no frames]

Class SSHSessionProtocol

BaseProtocol --+    
               |    
 ProcessProtocol --+
                   |
BaseProtocol --+   |
               |   |
        Protocol --+
                   |
                  SSHSessionProtocol


Method Summary
  __init__(self, session, client)
  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.
  errReceived(self, err)
  outReceived(self, data)
Called whenever data is received.
  processEnded(self, reason)
This will be called when the subprocess is finished.
    Inherited from Protocol
  connectionFailed(self)
(Deprecated)
    Inherited from ProcessProtocol
  childConnectionLost(self, childFD)
  childDataReceived(self, childFD, data)
  errConnectionLost(self)
This will be called when stderr is closed.
  inConnectionLost(self)
This will be called when stdin is closed.
  outConnectionLost(self)
This will be called when stdout is closed.
    Inherited from BaseProtocol
  makeConnection(self, transport)
Make a connection to a transport and a server.

Class Variable Summary
    Inherited from Protocol
tuple __implements__ = (<class twisted.internet.interfaces.IPr...
    Inherited from BaseProtocol
int connected = 0                                                                     
NoneType transport = None                                                                  

Method Details

connectionLost(self, reason=None)

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)

outReceived(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)

processEnded(self, reason=None)

This will be called when the subprocess is finished.
Parameters:
reason
           (type=twisted.python.failure.Failure)
Overrides:
twisted.internet.protocol.ProcessProtocol.processEnded (inherited documentation)

Generated by Epydoc 2.0 on Wed Feb 25 07:36:49 2004 http://epydoc.sf.net