Class t.c.s.c.SSHChannel(log.Logger):

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

Known subclasses: twisted.conch.client.agent.SSHAgentForwardingChannel, twisted.conch.client.unix.SSHUnixChannel, twisted.conch.scripts.cftp.SSHSession, twisted.conch.scripts.conch.SSHSession, twisted.conch.scripts.tkconch.SSHSession, twisted.conch.ssh.forwarding.SSHConnectForwardingChannel, twisted.conch.ssh.forwarding.SSHListenForwardingChannel, twisted.conch.ssh.session.SSHSession

No class docstring

Method	__init__	Undocumented
Method	__str__	Undocumented
Method	logPrefix	Override this method to insert custom logging behavior. Its
Method	channelOpen	Called when the channel is opened. specificData is any data that the
Method	openFailed	Called when the the open failed for some reason.
Method	addWindowBytes	Called when bytes are added to the remote window. By default it clears
Method	requestReceived	Called when a request is sent to this channel. By default it delegates
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	closeReceived	Called when the other side has closed the channel.
Method	closed	Called when the channel is closed. This means that both our side and
Method	write	Write some data to the channel. If there is not enough remote window
Method	writeExtended	Send extended data to this channel. If there is not enough remote
Method	writeSequence	Part of the Transport interface. Write a list of strings to the
Method	loseConnection	Close 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.
Method	startWriting	Called when the remote buffer has more room, as a hint to continue

def __init__(self, localWindow=0, localMaxPacket=0, remoteWindow=0, remoteMaxPacket=0, conn=None, data=None, avatar=None): (source)

overridden in twisted.conch.client.unix.SSHUnixChannel, twisted.conch.ssh.forwarding.SSHConnectForwardingChannel, twisted.conch.ssh.session.SSHSession

Undocumented

def __str__(self): (source)

Undocumented

def logPrefix(self): (source)

overrides twisted.python.log.Logger.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.

def channelOpen(self, specificData): (source)

overridden in twisted.conch.client.agent.SSHAgentForwardingChannel, twisted.conch.client.unix.SSHUnixChannel, twisted.conch.scripts.cftp.SSHSession, twisted.conch.scripts.conch.SSHSession, twisted.conch.scripts.tkconch.SSHSession, twisted.conch.ssh.forwarding.SSHConnectForwardingChannel, twisted.conch.ssh.forwarding.SSHListenForwardingChannel

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

Parameters specificData (type: str )

def openFailed(self, reason): (source)

overridden in twisted.conch.client.unix.SSHUnixChannel, twisted.conch.ssh.forwarding.SSHListenForwardingChannel

Called when the the open failed for some reason. reason.desc is a string descrption, reason.code the the SSH error code.

Parameters reason (type: error.ConchError )

def addWindowBytes(self, bytes): (source)

overridden in twisted.conch.client.unix.SSHUnixChannel

Called when bytes are added to the remote window. By default it clears the data buffers.

Parameters bytes (type: int )

def requestReceived(self, requestType, data): (source)

overridden in twisted.conch.client.unix.SSHUnixChannel

Called when a request is sent to this channel. By default it delegates to self.request_<requestType>. If this function returns true, the request succeeded, otherwise it failed.

Parameters	requestType	(type: `str` )
	data	(type: `str` )
Returns	(type: `bool` )

def dataReceived(self, data): (source)

overridden in twisted.conch.client.agent.SSHAgentForwardingChannel, twisted.conch.client.unix.SSHUnixChannel, twisted.conch.scripts.conch.SSHSession, twisted.conch.scripts.tkconch.SSHSession, twisted.conch.ssh.forwarding.SSHConnectForwardingChannel, twisted.conch.ssh.forwarding.SSHListenForwardingChannel, twisted.conch.ssh.session.SSHSession

Called when we receive data.

Parameters data (type: str )

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

overridden in twisted.conch.client.unix.SSHUnixChannel, twisted.conch.scripts.cftp.SSHSession, twisted.conch.scripts.conch.SSHSession, twisted.conch.scripts.tkconch.SSHSession, twisted.conch.ssh.session.SSHSession

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

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

def eofReceived(self): (source)

Called when the other side will send no more data.

def closeReceived(self): (source)

overridden in twisted.conch.client.unix.SSHUnixChannel, twisted.conch.scripts.cftp.SSHSession, twisted.conch.scripts.conch.SSHSession

Called when the other side has closed the channel.

def closed(self): (source)

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

def write(self, data): (source)

Write some data to the channel. If there is not enough remote window available, buffer until it is.

Parameters data (type: str )

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

Send extended data to this channel. If there is not enough remote window available, buffer until there is.

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

def writeSequence(self, data): (source)

Part of the Transport interface. Write a list of strings to the channel.

Parameters data (type: list of str )

def loseConnection(self): (source)

overridden in twisted.conch.ssh.session.SSHSession

Close the channel.

def getPeer(self): (source)

Return a tuple describing the other side of the connection.

Returns (type: tuple )

def getHost(self): (source)

Return a tuple describing our side of the connection.

Returns (type: tuple )

def stopWriting(self): (source)

overridden in twisted.conch.scripts.cftp.SSHSession, twisted.conch.scripts.conch.SSHSession

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

def startWriting(self): (source)

overridden in twisted.conch.scripts.cftp.SSHSession, twisted.conch.scripts.conch.SSHSession

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

API Documentation for twisted, generated by pydoctor.