twisted.conch.insults.client.InsultsClient : API documentation

Method	__init__	Undocumented
Method	setSize	Undocumented
Method	dataReceived	Called whenever data is received.
Method	endEscape	Undocumented
Method	initScreen	Undocumented
Method	gotoXY	Go to a position on the screen.
Method	writeCh	Write a character to the screen. If we're at the end of the row, ignore the write.
Method	writeStr	Write a string to the screen. This does not wrap a the edge of the screen, and stops at \r and \n.
Method	eraseToLine	Erase from the current position to the end of the line.
Method	eraseToScreen	Erase from the current position to the end of the screen.
Method	clearScreen	Clear the screen, and return the cursor to 0, 0.
Method	setAttributes	Set the attributes for drawing on the screen.
Method	refresh	Redraw the screen.
Method	windowSizeChanged	Called when the size of the window changes. Might want to redraw the screen here, or something.
Method	keyReceived	Called when the user hits a key.

Inherited from Protocol:

Method	logPrefix	Return a prefix matching the class name, to identify log messages related to this protocol instance.
Method	connectionLost	Called when the connection is shut down.

Inherited from BaseProtocol (via Protocol):

Method	makeConnection	Make a connection to a transport and a server.
Method	connectionMade	Called when a connection is made.

def __init__(self): (source)

Undocumented

def setSize(self, width, height): (source)

Undocumented

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

Undocumented

def initScreen(self): (source)

Undocumented

def gotoXY(self, x, y): (source)

Go to a position on the screen.

def writeCh(self, ch): (source)

Write a character to the screen. If we're at the end of the row, ignore the write.

def writeStr(self, s): (source)

Write a string to the screen. This does not wrap a the edge of the screen, and stops at \r and \n.

def eraseToLine(self): (source)

Erase from the current position to the end of the line.

def eraseToScreen(self): (source)

Erase from the current position to the end of the screen.

def clearScreen(self): (source)

Clear the screen, and return the cursor to 0, 0.

def setAttributes(self, *attrs): (source)

Set the attributes for drawing on the screen.

def refresh(self): (source)

Redraw the screen.

def windowSizeChanged(self): (source)

Called when the size of the window changes. Might want to redraw the screen here, or something.

def keyReceived(self, key): (source)

Called when the user hits a key.

twisted.conch.insults.client.InsultsClient(protocol.Protocol) class documentation

`twisted.conch.insults.client.InsultsClient(protocol.Protocol)` class documentation