twisted.conch.ssh.channel.SSHChannel

Package twisted :: Package conch :: Package ssh :: Module channel :: Class SSHChannel

[show private | hide private]

Class SSHChannel

Logger --+
         |
        SSHChannel

Known Subclasses:: CommandChannel

Method Summary
	`__init__(self, localWindow, localMaxPacket, remoteWindow, remoteMaxPacket, conn, data, avatar)`
	`__str__(self)`
	`addWindowBytes(self, bytes)` Called when bytes are added to the remote window.
	`channelOpen(self, specificData)` Called when the channel is opened.
	`closed(self)` Called when the channel is closed.
	`closeReceived(self)` Called when the other side has closed the channel.
	`dataReceived(self, data)` Called when we receive data.
	`eofReceived(self)` Called when the other side will send no more data.
	`extReceived(self, dataType, data)` Called when we receive extended data (usually standard error).
`tuple`	`getHost(self)` Return a tuple describing our side of the connection.
`tuple`	`getPeer(self)` Return a tuple describing the other side of the connection.
	`logPrefix(self)` Override this method to insert custom logging behavior.
	`loseConnection(self)` Close the channel.
	`openFailed(self, reason)` Called when the the open failed for some reason.
`bool`	`requestReceived(self, requestType, data)` Called when a request is sent to this channel.
	`startWriting(self)` Called when the remote buffer has more room, as a hint to continue writing.
	`stopWriting(self)` Called when the remote buffer is full, as a hint to stop writing.
	`write(self, data)` Write some data to the channel.
	`writeExtended(self, dataType, data)` Send extended data to this channel.
	`writeSequence(self, data)` Part of the Transport interface.

Class Variable Summary
`NoneType`	`name` = None
Inherited from `Logger`: `__implemented__`, `__providedBy__`, `__provides__`

Method Details

addWindowBytes(self, bytes)

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

Parameters:: bytes
(type=int)

channelOpen(self, specificData)

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

Parameters:: specificData
(type=str)

closed(self)

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

closeReceived(self)

Called when the other side has closed the channel.

dataReceived(self, data)

Called when we receive data.

Parameters:: data
(type=str)

eofReceived(self)

Called when the other side will send no more data.

extReceived(self, dataType, data)

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

Parameters:: dataType
(type=int); data
(type=str)

getHost(self)

Return a tuple describing our side of the connection.

Returns:: tuple

getPeer(self)

Return a tuple describing the other side of the connection.

Returns:: tuple

logPrefix(self)

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.

Overrides:: twisted.python.log.Logger.logPrefix (inherited documentation)

loseConnection(self)

Close the channel.

openFailed(self, reason)

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)

requestReceived(self, requestType, data)

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:: bool

startWriting(self)

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

stopWriting(self)

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

write(self, data)

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

Parameters:: data
(type=str)

writeExtended(self, dataType, data)

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)

writeSequence(self, data)

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

Parameters:: data
(type=list of str)

Class Variable Details

name

Type:: NoneType
Value:: None

Generated by Epydoc 2.1 on Thu Aug 16 09:55:09 2007

http://epydoc.sf.net