twisted.conch.ssh.forwarding.SSHForwardingClient : API documentation

Method	__init__	Undocumented
Method	dataReceived	Called whenever data is received.
Method	connectionLost	Called when the connection is shut down.

Inherited from BaseProtocol (via Protocol):

Method	makeConnection	Make a connection to a transport and a server.
Method	connectionMade	Called when a connection is made.

def __init__(self, channel): (source)

Undocumented

def dataReceived(self, data): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.dataReceived

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.

def connectionLost(self, reason): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.connectionLost

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 )

t.c.s.f.SSHForwardingClient(protocol.Protocol) : class documentation