t.c.a.ConchUser : class documentation

Part of twisted.conch.avatar View Source View In Hierarchy

Known subclasses: twisted.conch.manhole_ssh.TerminalUser, twisted.conch.unix.UnixConchUser

Implements interfaces: twisted.conch.interfaces.IConchUser

Undocumented
Method __init__ Undocumented
Method lookupChannel No summary
Method lookupSubsystem The other side requested a subsystem. subsystem is the name of the subsystem being requested. data is any other packet data (often nothing).
Method gotGlobalRequest A global request was sent from the other side.
def __init__(self): (source)
Undocumented
def lookupChannel(self, channelType, windowSize, maxPacket, data): (source)
The other side requested a channel of some sort. channelType is the type of channel being requested, windowSize is the initial size of the remote window, maxPacket is the largest packet we should send, data is any other packet data (often nothing).

We return a subclass of SSHChannel. If an appropriate channel can not be found, an exception will be raised. If a ConchError is raised, the .value will be the message, and the .data will be the error code.

Returns (type: subclass of SSHChannel/tuple)
def lookupSubsystem(self, subsystem, data): (source)
The other side requested a subsystem. subsystem is the name of the subsystem being requested. data is any other packet data (often nothing).

We return a Protocol.

def gotGlobalRequest(self, requestType, data): (source)
A global request was sent from the other side.

By default, this dispatches to a method 'channel_channelType' with any non-alphanumerics in the channelType replace with _'s. If it cannot find a suitable method, it returns an OPEN_UNKNOWN_CHANNEL_TYPE error. The method is called with arguments of windowSize, maxPacket, data.

API Documentation for Twisted, generated by pydoctor at 2012-09-01 11:44:56.