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

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

No class docstring
Method __init__ No summary
Method connectionMade Called when a connection is made.
Method dataReceived Called whenever data is received.
Method unhandledControlSequence Undocumented
Class ControlSequenceParser Undocumented
Method cursorUp Undocumented
Method cursorDown Undocumented
Method cursorForward Undocumented
Method cursorBackward Undocumented
Method cursorPosition Undocumented
Method cursorHome Undocumented
Method index Undocumented
Method reverseIndex Undocumented
Method nextLine Undocumented
Method saveCursor Undocumented
Method restoreCursor Undocumented
Method setModes Undocumented
Method setPrivateModes Undocumented
Method resetModes Undocumented
Method resetPrivateModes Undocumented
Method applicationKeypadMode Undocumented
Method numericKeypadMode Undocumented
Method selectCharacterSet Undocumented
Method shiftIn Undocumented
Method shiftOut Undocumented
Method singleShift2 Undocumented
Method singleShift3 Undocumented
Method selectGraphicRendition Undocumented
Method horizontalTabulationSet Undocumented
Method tabulationClear Undocumented
Method tabulationClearAll Undocumented
Method doubleHeightLine Undocumented
Method singleWidthLine Undocumented
Method doubleWidthLine Undocumented
Method eraseToLineEnd Undocumented
Method eraseToLineBeginning Undocumented
Method eraseLine Undocumented
Method eraseToDisplayEnd Undocumented
Method eraseToDisplayBeginning Undocumented
Method eraseDisplay Undocumented
Method deleteCharacter Undocumented
Method insertLine Undocumented
Method deleteLine Undocumented
Method setScrollRegion Undocumented
Method resetScrollRegion Undocumented
Method reportCursorPosition Undocumented
Method reset Undocumented
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

Inherited from Protocol:

Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.

Inherited from BaseProtocol (via Protocol):

Method makeConnection Make a connection to a transport and a server.
def __init__(self, *a, protocolFactory=None, **kw): (source)
ParametersprotocolFactoryA 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.
aAny positional arguments to pass to protocolFactory.
kwAny keyword arguments to pass to protocolFactory.
def connectionMade(self): (source)
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)
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.

Parametersdataa 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)
Undocumented
def _handleLowFunctionControlSequence(self, ch): (source)
Undocumented
def cursorUp(self, n=1): (source)
Undocumented
def cursorDown(self, n=1): (source)
Undocumented
def cursorForward(self, n=1): (source)
Undocumented
def cursorBackward(self, n=1): (source)
Undocumented
def cursorPosition(self, column, line): (source)
Undocumented
def cursorHome(self): (source)
Undocumented
def index(self): (source)
Undocumented
def reverseIndex(self): (source)
Undocumented
def nextLine(self): (source)
Undocumented
def saveCursor(self): (source)
Undocumented
def restoreCursor(self): (source)
Undocumented
def setModes(self, modes): (source)
Undocumented
def setPrivateModes(self, modes): (source)
Undocumented
def resetModes(self, modes): (source)
Undocumented
def resetPrivateModes(self, modes): (source)
Undocumented
def applicationKeypadMode(self): (source)
Undocumented
def numericKeypadMode(self): (source)
Undocumented
def selectCharacterSet(self, charSet, which): (source)
Undocumented
def shiftIn(self): (source)
Undocumented
def shiftOut(self): (source)
Undocumented
def singleShift2(self): (source)
Undocumented
def singleShift3(self): (source)
Undocumented
def selectGraphicRendition(self, *attributes): (source)
Undocumented
def horizontalTabulationSet(self): (source)
Undocumented
def tabulationClear(self): (source)
Undocumented
def tabulationClearAll(self): (source)
Undocumented
def doubleHeightLine(self, top=True): (source)
Undocumented
def singleWidthLine(self): (source)
Undocumented
def doubleWidthLine(self): (source)
Undocumented
def eraseToLineEnd(self): (source)
Undocumented
def eraseToLineBeginning(self): (source)
Undocumented
def eraseLine(self): (source)
Undocumented
def eraseToDisplayEnd(self): (source)
Undocumented
def eraseToDisplayBeginning(self): (source)
Undocumented
def eraseDisplay(self): (source)
Undocumented
def deleteCharacter(self, n=1): (source)
Undocumented
def insertLine(self, n=1): (source)
Undocumented
def deleteLine(self, n=1): (source)
Undocumented
def setScrollRegion(self, first=None, last=None): (source)
Undocumented
def resetScrollRegion(self): (source)
Undocumented
def reportCursorPosition(self): (source)
Undocumented
def reset(self): (source)
Undocumented
def write(self, bytes): (source)
Undocumented
def writeSequence(self, bytes): (source)
Undocumented
def loseConnection(self): (source)
Undocumented
def connectionLost(self, reason): (source)
Called when the connection is shut down.

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

API Documentation for Twisted, generated by pydoctor at 2015-01-30 14:14:53.