t.c.i.i.TerminalProtocol(object) : class documentation

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

Known subclasses: twisted.conch.recvline.RecvLine

Implements interfaces: twisted.conch.insults.insults.ITerminalProtocol

No class docstring
Method makeConnection Called with an ITerminalTransport when a connection is established.
Method connectionMade Called after a connection has been established.
Method keystrokeReceived A keystroke was received.
Method terminalSize Called to indicate the size of the terminal.
Method unhandledControlSequence Called when an unsupported control sequence is received.
Method connectionLost Called when the connection has been lost.
def makeConnection(self, terminal): (source)
from twisted.conch.insults.insults.ITerminalProtocol
Called with an ITerminalTransport when a connection is established.
def connectionMade(self): (source)
overridden in twisted.conch.recvline.RecvLine
Called after a connection has been established.
def keystrokeReceived(self, keyID, modifier): (source)
from twisted.conch.insults.insults.ITerminalProtocol
overridden in twisted.conch.recvline.RecvLine

A keystroke was received.

Each keystroke corresponds to one invocation of this method. keyID is a string identifier for that key. Printable characters are represented by themselves. Control keys, such as arrows and function keys, are represented with symbolic constants on ServerProtocol.
def terminalSize(self, width, height): (source)
from twisted.conch.insults.insults.ITerminalProtocol
overridden in twisted.conch.recvline.RecvLine

Called to indicate the size of the terminal.

A terminal of 80x24 should be assumed if this method is not called. This method might not be called for real terminals.
def unhandledControlSequence(self, seq): (source)
from twisted.conch.insults.insults.ITerminalProtocol
overridden in twisted.conch.recvline.RecvLine
Called when an unsupported control sequence is received.
ParametersseqThe whole control sequence which could not be interpreted. (type: str )
def connectionLost(self, reason): (source)
from twisted.conch.insults.insults.ITerminalProtocol
overridden in twisted.conch.stdio.ConsoleManhole

Called when the connection has been lost.

reason is a Failure describing why.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 15:46:52.