Go to the latest version of this document.

# ``twisted`.`conch`.`ssh`.`filetransfer`.`FileTransferBase``

class documentation

`class FileTransferBase(protocol.Protocol): (source)`

Known subclasses: `twisted.conch.ssh.filetransfer.FileTransferClient`, `twisted.conch.ssh.filetransfer.FileTransferServer`

View In Hierarchy

Undocumented

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

Inherited from `Protocol`:

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

Inherited from `BaseProtocol` (via `Protocol`):

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

def __init__(self): (source)
overridden in `twisted.conch.ssh.filetransfer.FileTransferClient`, `twisted.conch.ssh.filetransfer.FileTransferServer`

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.

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

Undocumented

packetTypes: `dict[int, str]` = (source)

Undocumented

versions: `tuple[int, ...]` = (source)

Undocumented

buf: `bytes` = (source)

Undocumented

connected: `bool` = (source)
overrides `twisted.internet.protocol.BaseProtocol.connected`

Undocumented

otherVersion = (source)

Undocumented

def _packAttributes(self, attrs): (source)

Undocumented

def _parseAttributes(self, data): (source)

Undocumented

_log = (source)

Undocumented