t.c.s.s.SSHSession(channel.SSHChannel) : class documentation

Part of twisted.conch.ssh.session View Source View In Hierarchy

Undocumented

Method	__init__	Undocumented
Method	request_subsystem	Undocumented
Method	request_shell	Undocumented
Method	request_exec	Undocumented
Method	request_pty_req	Undocumented
Method	request_window_change	Undocumented
Method	dataReceived	Called when we receive data.
Method	extReceived	Called when we receive extended data (usually standard error).
Method	eofReceived	Called when the other side will send no more data.
Method	closed	Called when the channel is closed. This means that both our side and the remote side have closed the channel.
Method	loseConnection	Close the channel if there is no buferred data. Otherwise, note the request and return.

Inherited from SSHChannel:

Method	__str__	Undocumented
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	channelOpen	Called when the channel is opened. specificData is any data that the other side sent us when opening the channel.
Method	openFailed	Called when the the open failed for some reason. reason.desc is a string descrption, reason.code the the SSH error code.
Method	addWindowBytes	Called when bytes are added to the remote window. By default it clears the data buffers.
Method	requestReceived	No summary
Method	closeReceived	Called when the other side has closed the channel.
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.
Method	getPeer	Return a tuple describing the other side of the connection.
Method	getHost	Return a tuple describing our side of the connection.
Method	stopWriting	Called when the remote buffer is full, as a hint to stop writing. This can be ignored, but it can be helpful.
Method	startWriting	Called when the remote buffer has more room, as a hint to continue writing.

def __init__(self, *args, **kw): (source)

overrides twisted.conch.ssh.channel.SSHChannel.__init__

Undocumented

def request_subsystem(self, data): (source)

Undocumented

def request_shell(self, data): (source)

Undocumented

def request_exec(self, data): (source)

Undocumented

def request_pty_req(self, data): (source)

Undocumented

def request_window_change(self, data): (source)

Undocumented

def dataReceived(self, data): (source)

overrides twisted.conch.ssh.channel.SSHChannel.dataReceived

Called when we receive data.

Parameters data (type: str )

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

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

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

Parameters	dataType	(type: `int` )
	data	(type: `str` )

def eofReceived(self): (source)

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

Called when the other side will send no more data.

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 loseConnection(self): (source)

from twisted.internet.interfaces.ITransport

overrides twisted.conch.ssh.channel.SSHChannel.loseConnection

Close the channel if there is no buferred data. Otherwise, note the request and return.

API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:17:34.