Robot Framework SSH Library
SSHLibrary.pythonclient.Shell Class Reference
Inheritance diagram for SSHLibrary.pythonclient.Shell:
SSHLibrary.abstractclient.AbstractShell

Public Member Functions

def __init__ (self, client, term_type, term_width, term_height)
 
def read (self)
 Reads all the output from the shell. More...
 
def read_byte (self)
 Reads a single byte from the shell. More...
 
def resize (self, width, height)
 
def write (self, text)
 Writes the text in the current shell. More...
 

Private Member Functions

def _output_available (self)
 

Private Attributes

 _shell
 

Detailed Description

Definition at line 305 of file pythonclient.py.

Constructor & Destructor Documentation

◆ __init__()

def SSHLibrary.pythonclient.Shell.__init__ (   self,
  client,
  term_type,
  term_width,
  term_height 
)

Definition at line 307 of file pythonclient.py.

Member Function Documentation

◆ _output_available()

def SSHLibrary.pythonclient.Shell._output_available (   self)
private

Definition at line 327 of file pythonclient.py.

◆ read()

def SSHLibrary.pythonclient.Shell.read (   self)

Reads all the output from the shell.

    :returns: The read output.

Reimplemented from SSHLibrary.abstractclient.AbstractShell.

Definition at line 313 of file pythonclient.py.

◆ read_byte()

def SSHLibrary.pythonclient.Shell.read_byte (   self)

Reads a single byte from the shell.

    :returns: The read byte.

Reimplemented from SSHLibrary.abstractclient.AbstractShell.

Definition at line 319 of file pythonclient.py.

◆ resize()

def SSHLibrary.pythonclient.Shell.resize (   self,
  width,
  height 
)

Definition at line 324 of file pythonclient.py.

◆ write()

def SSHLibrary.pythonclient.Shell.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 from SSHLibrary.abstractclient.AbstractShell.

Definition at line 330 of file pythonclient.py.

Member Data Documentation

◆ _shell

SSHLibrary.pythonclient.Shell._shell
private

Definition at line 309 of file pythonclient.py.


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