class documentation

class ExpectableBuffer(TerminalBuffer): (source)

View In Hierarchy

Undocumented

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

Inherited from TerminalBuffer:

Method __bytes__ Undocumented
Method applicationKeypadMode Cause keypad to generate control functions.
Method cursorBackward Move the cursor left n columns.
Method cursorDown Move the cursor down n lines.
Method cursorForward Move the cursor right n columns.
Method cursorPosition Move the cursor to the given line and column.
Method cursorUp Move the cursor up n lines.
Method deleteCharacter Delete n characters starting at the cursor position.
Method deleteLine Delete n lines starting at the cursor position.
Method doubleHeightLine Make the current line the top or bottom half of a double-height, double-width line.
Method doubleWidthLine Make the current line a double-width line.
Method eraseDisplay Erase the entire display.
Method eraseLine Erase the entire cursor line.
Method eraseToDisplayBeginning Erase from the cursor to the beginning of the display, including the cursor position.
Method eraseToDisplayEnd Erase from the cursor to the end of the display, including the cursor position.
Method eraseToLineBeginning Erase from the cursor to the beginning of the line, including the cursor position.
Method eraseToLineEnd Erase from the cursor to the end of line, including cursor position.
Method getCharacter Undocumented
Method getHost Similar to getPeer, but returns an address describing this side of the connection.
Method getPeer Get the remote address of this connection.
Method horizontalTabulationSet Set a tab stop at the current cursor position.
Method index Move the cursor down one line, performing scrolling if necessary.
Method insertAtCursor Add one byte to the terminal at the cursor and make consequent state updates.
Method insertLine Insert n lines at the cursor position.
Method loseConnection Close my connection, after writing all pending data.
Method nextLine Update the cursor position attributes and scroll down if appropriate.
Method numericKeypadMode Cause keypad to generate normal characters.
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 resetModes Reset the given modes on the terminal.
Method resetPrivateModes Disable the given modes.
Method restoreCursor Restore the previously saved cursor position, character attribute, character set, and origin mode selection.
Method reverseIndex Move the cursor up one line, performing scrolling if necessary.
Method saveCursor Save the cursor position, character attribute, character set, and origin mode selection.
Method selectCharacterSet Select a character set.
Method selectGraphicRendition Enabled one or more character attributes.
Method setModes Set the given modes on the terminal.
Method setPrivateModes Enable the given modes.
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 singleWidthLine Make the current line a single-width, single-height line.
Method tabulationClear Clear the tab stop at the current cursor position.
Method tabulationClearAll Clear all tab stops.
Method unhandledControlSequence Called when an unsupported control sequence is received.
Method writeSequence Write an iterable of byte strings to the physical connection.
Class Variable BACKSPACE Undocumented
Class Variable execBytes Undocumented
Class Variable execStr Undocumented
Class Variable fill Undocumented
Class Variable height Undocumented
Class Variable TAB Undocumented
Class Variable void Undocumented
Class Variable width Undocumented
Instance Variable activeCharset Undocumented
Instance Variable charsets Undocumented
Instance Variable graphicRendition Undocumented
Instance Variable home Undocumented
Instance Variable keypadMode Undocumented
Instance Variable lines Undocumented
Instance Variable modes Undocumented
Instance Variable numericKeypad Undocumented
Instance Variable privateModes Undocumented
Instance Variable x Undocumented
Instance Variable y Undocumented
Method _currentFormattingState Undocumented
Method _emptyLine Undocumented
Method _scrollDown Undocumented
Method _scrollUp Undocumented
Class Variable _log Undocumented
Instance Variable _savedCursor Undocumented

Inherited from Protocol (via TerminalBuffer):

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

Inherited from BaseProtocol (via TerminalBuffer, Protocol):

Method makeConnection Make a connection to a transport and a server.
Instance Variable connected Undocumented
Instance Variable transport Undocumented
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 expect(self, expression, timeout=None, scheduler=reactor): (source)

Undocumented

def write(self, data): (source)

Add the given printable bytes to the terminal.

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

def _checkExpected(self): (source)

Undocumented

def _timeoutExpected(self, d): (source)

Undocumented

_expecting: list = (source)

Undocumented

_mark: int = (source)

Undocumented