twisted.conch.ssh.filetransfer.FileTransferBase : API documentation

Class Variable	versions	Undocumented
Class Variable	packetTypes	Undocumented
Method	__init__	Undocumented
Instance Variable	buf	Undocumented
Instance Variable	otherVersion	Undocumented
Method	sendPacket	Undocumented
Method	dataReceived	Called whenever data is received.
Method	connectionLost	Called when connection to the remote subsystem was lost.
Instance Variable	connected	Undocumented
Class Variable	_log	Undocumented
Method	_parseAttributes	Undocumented
Method	_packAttributes	Undocumented

Inherited from Protocol:

Class Variable	factory	Undocumented
Method	logPrefix	Return a prefix matching the class name, to identify log messages related to this protocol instance.

Inherited from BaseProtocol (via Protocol):

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

_log = (source)

Undocumented

versions = (source)

Undocumented

(type: tuple[int, ...])

packetTypes = (source)

Undocumented

(type: Dict[int, str])

def __init__(self): (source)

overridden in twisted.conch.ssh.filetransfer.FileTransferClient, twisted.conch.ssh.filetransfer.FileTransferServer

Undocumented

buf = (source)

Undocumented

otherVersion = (source)

Undocumented

def sendPacket(self, kind, data): (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 _parseAttributes(self, data): (source)

Undocumented

def _packAttributes(self, attrs): (source)

Undocumented

def connectionLost(self, reason): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.connectionLost

overridden in twisted.conch.ssh.filetransfer.FileTransferClient, twisted.conch.ssh.filetransfer.FileTransferServer

Called when connection to the remote subsystem was lost.

connected = (source)

overrides twisted.internet.protocol.BaseProtocol.connected

Undocumented

(type: bool)