twisted.conch.insults.insults.ITerminalProtocol : API documentation

class twisted.conch.insults.insults.ITerminalProtocol(Interface): (source)

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

Method	makeConnection	Called with an `ITerminalTransport` when a connection is 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(transport): (source)

Called with an ITerminalTransport when a connection is established.

def keystrokeReceived(keyID, modifier): (source)

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(width, height): (source)

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

Called when an unsupported control sequence is received.

Parameters seq The whole control sequence which could not be interpreted. (type: str)

def connectionLost(reason): (source)

Called when the connection has been lost.

reason is a Failure describing why.