twisted.conch.insults.insults.ServerProtocol : API documentation

def __init__(self, *a, protocolFactory=None, **kw): (source)

Parameters	protocolFactory	A callable which will be invoked with a, *kw and should return an ITerminalProtocol implementor. This will be invoked when a connection to this ServerProtocol is established.
	a	Any positional arguments to pass to protocolFactory.
	kw	Any keyword arguments to pass to protocolFactory.

def connectionMade(self): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.BaseProtocol.connectionMade

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.

def dataReceived(self, data): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.dataReceived

Called whenever data is received.

Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.

Parameters data a string of indeterminate length. Please keep in mind that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.

def _handleShortControlSequence(self, ch): (source)

Undocumented

def _handleControlSequence(self, buf): (source)

Undocumented

def unhandledControlSequence(self, buf): (source)

from twisted.conch.insults.insults.ITerminalTransport

Called when an unsupported control sequence is received.

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

def _handleLowFunctionControlSequence(self, ch): (source)

Undocumented

def cursorUp(self, n=1): (source)

from twisted.conch.insults.insults.ITerminalTransport

Move the cursor up n lines.

def cursorDown(self, n=1): (source)

from twisted.conch.insults.insults.ITerminalTransport

Move the cursor down n lines.

def cursorForward(self, n=1): (source)

from twisted.conch.insults.insults.ITerminalTransport

Move the cursor right n columns.

def cursorBackward(self, n=1): (source)

from twisted.conch.insults.insults.ITerminalTransport

Move the cursor left n columns.

def cursorPosition(self, column, line): (source)

from twisted.conch.insults.insults.ITerminalTransport

Move the cursor to the given line and column.

def cursorHome(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Move the cursor home.

def index(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Move the cursor down one line, performing scrolling if necessary.

def reverseIndex(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Move the cursor up one line, performing scrolling if necessary.

def nextLine(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Move the cursor to the first position on the next line, performing scrolling if necessary.

def saveCursor(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Save the cursor position, character attribute, character set, and origin mode selection.

def restoreCursor(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Restore the previously saved cursor position, character attribute, character set, and origin mode selection.

If no cursor state was previously saved, move the cursor to the home position.

def setModes(self, modes): (source)

from twisted.conch.insults.insults.ITerminalTransport

Set the given modes on the terminal.

def setPrivateModes(self, modes): (source)

from twisted.conch.insults.insults.ITerminalTransport

Set the given DEC private modes on the terminal.

def resetModes(self, modes): (source)

from twisted.conch.insults.insults.ITerminalTransport

Reset the given modes on the terminal.

def resetPrivateModes(self, modes): (source)

from twisted.conch.insults.insults.ITerminalTransport

Reset the given DEC private modes on the terminal.

def applicationKeypadMode(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Cause keypad to generate control functions.

Cursor key mode selects the type of characters generated by cursor keys.

def numericKeypadMode(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Cause keypad to generate normal characters.

def selectCharacterSet(self, charSet, which): (source)

from twisted.conch.insults.insults.ITerminalTransport

Select a character set.

charSet should be one of CS_US, CS_UK, CS_DRAWING, CS_ALTERNATE, or CS_ALTERNATE_SPECIAL.

which should be one of G0 or G1.

def shiftIn(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Activate the G0 character set.

def shiftOut(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Activate the G1 character set.

def singleShift2(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Shift to the G2 character set for a single character.

def singleShift3(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Shift to the G3 character set for a single character.

def selectGraphicRendition(self, *attributes): (source)

from twisted.conch.insults.insults.ITerminalTransport

Enabled one or more character attributes.

Arguments should be one or more of UNDERLINE, REVERSE_VIDEO, BLINK, or BOLD. NORMAL may also be specified to disable all character attributes.

def horizontalTabulationSet(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Set a tab stop at the current cursor position.

def tabulationClear(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Clear the tab stop at the current cursor position.

def tabulationClearAll(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Clear all tab stops.

def doubleHeightLine(self, top=True): (source)

from twisted.conch.insults.insults.ITerminalTransport

Make the current line the top or bottom half of a double-height, double-width line.

If top is True, the current line is the top half. Otherwise, it is the bottom half.

def singleWidthLine(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Make the current line a single-width, single-height line.

def doubleWidthLine(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Make the current line a double-width line.

def eraseToLineEnd(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Erase from the cursor to the end of line, including cursor position.

def eraseToLineBeginning(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Erase from the cursor to the beginning of the line, including the cursor position.

def eraseLine(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Erase the entire cursor line.

def eraseToDisplayEnd(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Erase from the cursor to the end of the display, including the cursor position.

def eraseToDisplayBeginning(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Erase from the cursor to the beginning of the display, including the cursor position.

def eraseDisplay(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Erase the entire display.

def deleteCharacter(self, n=1): (source)

from twisted.conch.insults.insults.ITerminalTransport

Delete n characters starting at the cursor position.

Characters to the right of deleted characters are shifted to the left.

def insertLine(self, n=1): (source)

from twisted.conch.insults.insults.ITerminalTransport

Insert n lines at the cursor position.

Lines below the cursor are shifted down. Lines moved past the bottom margin are lost. This command is ignored when the cursor is outside the scroll region.

def deleteLine(self, n=1): (source)

from twisted.conch.insults.insults.ITerminalTransport

Delete n lines starting at the cursor position.

Lines below the cursor are shifted up. This command is ignored when the cursor is outside the scroll region.

def setScrollRegion(self, first=None, last=None): (source)

Undocumented

def resetScrollRegion(self): (source)

Undocumented

def reportCursorPosition(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Return a Deferred that fires with a two-tuple of (x, y) indicating the cursor position.

def reset(self): (source)

from twisted.conch.insults.insults.ITerminalTransport

Reset the terminal to its initial state.

def write(self, bytes): (source)

Undocumented

def writeSequence(self, bytes): (source)

Undocumented

def loseConnection(self): (source)

Undocumented

def connectionLost(self, reason): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.connectionLost

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

Method	__init__	No summary
Method	connectionMade	Called when a connection is made.
Method	dataReceived	Called whenever data is received.
Method	unhandledControlSequence	Called when an unsupported control sequence is received.
Class	ControlSequenceParser	Undocumented
Method	cursorUp	Move the cursor up n lines.
Method	cursorDown	Move the cursor down n lines.
Method	cursorForward	Move the cursor right n columns.
Method	cursorBackward	Move the cursor left n columns.
Method	cursorPosition	Move the cursor to the given line and column.
Method	cursorHome	Move the cursor home.
Method	index	Move the cursor down one line, performing scrolling if necessary.
Method	reverseIndex	Move the cursor up one line, performing scrolling if necessary.
Method	nextLine	Move the cursor to the first position on the next line, performing scrolling if necessary.
Method	saveCursor	Save the cursor position, character attribute, character set, and origin mode selection.
Method	restoreCursor	Restore the previously saved cursor position, character attribute, character set, and origin mode selection.
Method	setModes	Set the given modes on the terminal.
Method	setPrivateModes	Set the given DEC private modes on the terminal.
Method	resetModes	Reset the given modes on the terminal.
Method	resetPrivateModes	Reset the given DEC private modes on the terminal.
Method	applicationKeypadMode	Cause keypad to generate control functions.
Method	numericKeypadMode	Cause keypad to generate normal characters.
Method	selectCharacterSet	Select a character set.
Method	shiftIn	Activate the G0 character set.
Method	shiftOut	Activate the G1 character set.
Method	singleShift2	Shift to the G2 character set for a single character.
Method	singleShift3	Shift to the G3 character set for a single character.
Method	selectGraphicRendition	Enabled one or more character attributes.
Method	horizontalTabulationSet	Set a tab stop at the current cursor position.
Method	tabulationClear	Clear the tab stop at the current cursor position.
Method	tabulationClearAll	Clear all tab stops.
Method	doubleHeightLine	Make the current line the top or bottom half of a double-height, double-width line.
Method	singleWidthLine	Make the current line a single-width, single-height line.
Method	doubleWidthLine	Make the current line a double-width line.
Method	eraseToLineEnd	Erase from the cursor to the end of line, including cursor position.
Method	eraseToLineBeginning	Erase from the cursor to the beginning of the line, including the cursor position.
Method	eraseLine	Erase the entire cursor line.
Method	eraseToDisplayEnd	Erase from the cursor to the end of the display, including the cursor position.
Method	eraseToDisplayBeginning	Erase from the cursor to the beginning of the display, including the cursor position.
Method	eraseDisplay	Erase the entire display.
Method	deleteCharacter	Delete n characters starting at the cursor position.
Method	insertLine	Insert n lines at the cursor position.
Method	deleteLine	Delete n lines starting at the cursor position.
Method	setScrollRegion	Undocumented
Method	resetScrollRegion	Undocumented
Method	reportCursorPosition	Return a Deferred that fires with a two-tuple of (x, y) indicating the cursor position.
Method	reset	Reset the terminal to its initial state.
Method	write	Undocumented
Method	writeSequence	Undocumented
Method	loseConnection	Undocumented
Method	connectionLost	Called when the connection is shut down.
Method	_handleShortControlSequence	Undocumented
Method	_handleControlSequence	Undocumented
Method	_handleLowFunctionControlSequence	Undocumented

t.c.i.i.ServerProtocol(protocol.Protocol) : class documentation