t.c.i.h.ExpectableBuffer(TerminalBuffer) : class documentation

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

Undocumented
Method connectionMade Called when a connection is made.
Method write Add the given printable bytes to the terminal.
Method cursorHome Move the cursor home.
Method expect Undocumented
Method _timeoutExpected Undocumented
Method _checkExpected Undocumented

Inherited from TerminalBuffer:

Method getCharacter Undocumented
Method insertAtCursor Add one byte to the terminal at the cursor and make consequent state updates.
Method cursorUp Move the cursor up n lines.
Method cursorDown Move the cursor down n lines.
Method cursorBackward Move the cursor left n columns.
Method cursorForward Move the cursor right n columns.
Method cursorPosition Move the cursor to the given line and column.
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 Update the cursor position attributes and scroll down if appropriate.
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 resetModes Reset the given modes on the terminal.
Method setPrivateModes Enable the given modes.
Method resetPrivateModes Disable the given modes.
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 eraseLine Erase the entire cursor 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 eraseDisplay Erase the entire display.
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 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 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 unhandledControlSequence Called when an unsupported control sequence is received.
Method __str__ Undocumented
Method _currentFormattingState Undocumented
Method _emptyLine Undocumented
Method _scrollDown Undocumented
Method _scrollUp Undocumented

Inherited from Protocol (via TerminalBuffer):

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

Inherited from BaseProtocol (via TerminalBuffer, Protocol):

Method makeConnection Make a connection to a transport and a server.
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 write(self, bytes): (source)
Add the given printable bytes to the terminal.

Line feeds in bytes will be replaced with carriage return / line feed pairs.

def cursorHome(self): (source)
Move the cursor home.
def _timeoutExpected(self, d): (source)
Undocumented
def _checkExpected(self): (source)
Undocumented
def expect(self, expression, timeout=None, scheduler=reactor): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2014-05-12 18:27:00.