twisted.conch.insults.insults.ITerminalProtocol

interface documentation

class ITerminalProtocol(Interface):

Known implementations: twisted.conch.insults.insults.TerminalProtocol

View In Hierarchy

Undocumented

Method connectionLost Called when the connection has been lost.
Method keystrokeReceived A keystroke was received.
Method makeConnection Called with an ITerminalTransport when a connection is established.
Method terminalSize Called to indicate the size of the terminal.
Method unhandledControlSequence Called when an unsupported control sequence is received.
def connectionLost(reason):

Called when the connection has been lost.

reason is a Failure describing why.

def keystrokeReceived(keyID, modifier):

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 makeConnection(transport):

Called with an ITerminalTransport when a connection is established.

def terminalSize(width, height):

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(seq):

Called when an unsupported control sequence is received.

Parameters
seq:strThe whole control sequence which could not be interpreted.