twisted.conch.scripts.cftp.SSHSession

class documentation

class SSHSession(channel.SSHChannel): (source)

Undocumented

Method	`channelOpen`	Called when the channel is opened. specificData is any data that the other side sent us when opening the channel.
Method	`closed`	Called when the channel is closed. This means that both our side and the remote side have closed the channel.
Method	`closeReceived`	Called when the other side has closed the channel.
Method	`eofReceived`	Called when the other side will send no more data.
Method	`extReceived`	Called when we receive extended data (usually standard error).
Method	`startWriting`	Called when the remote buffer has more room, as a hint to continue writing.
Method	`stopWriting`	Called when the remote buffer is full, as a hint to stop writing. This can be ignored, but it can be helpful.
Class Variable	`name`	Undocumented
Instance Variable	`client`	Undocumented
Instance Variable	`stdio`	Undocumented
Method	`_cbSubsystem`	Undocumented

Inherited from SSHChannel:

Method	`__bytes__`	Return a byte string representation of the channel
Method	`__init__`	Undocumented
Method	`__str__`	Undocumented
Method	`addWindowBytes`	Called when bytes are added to the remote window. By default it clears the data buffers.
Method	`dataReceived`	Called when we receive data.
Method	`getHost`	See: `ITransport.getHost`
Method	`getPeer`	See: `ITransport.getPeer`
Method	`logPrefix`	Override this method to insert custom logging behavior. Its return value will be inserted in front of every line. It may be called more times than the number of output lines.
Method	`loseConnection`	Close the channel if there is no buferred data. Otherwise, note the request and return.
Method	`openFailed`	Called when the open failed for some reason. reason.desc is a string descrption, reason.code the SSH error code.
Method	`requestReceived`	No summary
Method	`write`	Write some data to the channel. If there is not enough remote window available, buffer until it is. Otherwise, split the data into packets of length remoteMaxPacket and send them.
Method	`writeExtended`	Send extended data to this channel. If there is not enough remote window available, buffer until there is. Otherwise, split the data into packets of length remoteMaxPacket and send them.
Method	`writeSequence`	Part of the Transport interface. Write a list of strings to the channel.
Instance Variable	`areWriting`	Undocumented
Instance Variable	`avatar`	an avatar for the logged-in user (if a server channel)
Instance Variable	`buf`	Undocumented
Instance Variable	`closing`	Undocumented
Instance Variable	`conn`	the connection this channel is multiplexed through.
Instance Variable	`data`	any data to send to the other side when the channel is requested.
Instance Variable	`extBuf`	Undocumented
Instance Variable	`id`	Undocumented
Instance Variable	`localClosed`	True if we aren't accepting more data.
Instance Variable	`localMaxPacket`	the maximum size of packet we will accept in bytes.
Instance Variable	`localWindowLeft`	how many bytes are left in the local window.
Instance Variable	`localWindowSize`	the maximum size of the local window in bytes.
Instance Variable	`remoteClosed`	True if the other side isn't accepting more data.
Instance Variable	`remoteMaxPacket`	the maximum size of a packet the remote side will accept in bytes.
Instance Variable	`remoteWindowLeft`	how many bytes are left in the remote window.
Instance Variable	`specificData`	Undocumented
Class Variable	`_log`	Undocumented

def channelOpen(self, foo): (source)

overrides twisted.conch.ssh.channel.SSHChannel.channelOpen

Called when the channel is opened. specificData is any data that the other side sent us when opening the channel.

Parameters
foo	Undocumented
specificData:`bytes`	Undocumented

def closed(self): (source)

overrides twisted.conch.ssh.channel.SSHChannel.closed

Called when the channel is closed. This means that both our side and the remote side have closed the channel.

def closeReceived(self): (source)

overrides twisted.conch.ssh.channel.SSHChannel.closeReceived

Called when the other side has closed the channel.

def eofReceived(self): (source)

overrides twisted.conch.ssh.channel.SSHChannel.eofReceived

Called when the other side will send no more data.

def extReceived(self, t, data): (source)

overrides twisted.conch.ssh.channel.SSHChannel.extReceived

Called when we receive extended data (usually standard error).

Parameters
t	Undocumented
data:`str`	Undocumented
dataType:`int`	Undocumented

def startWriting(self): (source)

overrides twisted.conch.ssh.channel.SSHChannel.startWriting

Called when the remote buffer has more room, as a hint to continue writing.

def stopWriting(self): (source)

overrides twisted.conch.ssh.channel.SSHChannel.stopWriting

Called when the remote buffer is full, as a hint to stop writing. This can be ignored, but it can be helpful.

name: bytes = (source)

overrides twisted.conch.ssh.channel.SSHChannel.name

Undocumented

client = (source)

Undocumented

stdio = (source)

Undocumented

def _cbSubsystem(self, result): (source)

Undocumented