Robot Framework SSH Library
SSHLibrary.abstractclient.AbstractShell Class Reference

Base class for the shell implementation. More...

Inheritance diagram for SSHLibrary.abstractclient.AbstractShell:
SSHLibrary.javaclient.Shell SSHLibrary.pythonclient.Shell

Public Member Functions

def read (self)
 Reads all the output from the shell. More...
 
def read_byte (self)
 Reads a single byte from the shell. More...
 
def write (self, text)
 Writes the text in the current shell. More...
 

Detailed Description

Base class for the shell implementation.

Classes derived from this class (i.e. :py:class:`pythonclient.Shell`
and :py:class:`javaclient.Shell`) provide the concrete and the language
specific implementations for reading and writing in a shell session.

Definition at line 781 of file abstractclient.py.

Member Function Documentation

◆ read()

def SSHLibrary.abstractclient.AbstractShell.read (   self)

Reads all the output from the shell.

    :returns: The read output.

Reimplemented in SSHLibrary.pythonclient.Shell, and SSHLibrary.javaclient.Shell.

Definition at line 787 of file abstractclient.py.

◆ read_byte()

def SSHLibrary.abstractclient.AbstractShell.read_byte (   self)

Reads a single byte from the shell.

    :returns: The read byte.

Reimplemented in SSHLibrary.pythonclient.Shell, and SSHLibrary.javaclient.Shell.

Definition at line 794 of file abstractclient.py.

◆ write()

def SSHLibrary.abstractclient.AbstractShell.write (   self,
  text 
)

Writes the text in the current shell.

    :param str text: The text to be written. No newline characters are
        be appended automatically to the written text by this method.

Reimplemented in SSHLibrary.pythonclient.Shell, and SSHLibrary.javaclient.Shell.

Definition at line 802 of file abstractclient.py.


The documentation for this class was generated from the following file: