class documentation

class SSHChildROSLaunchProcess(roslaunch.server.ChildROSLaunchProcess):

Constructor: SSHChildROSLaunchProcess(run_id, name, server_uri, machine, ...)

View In Hierarchy

Process wrapper for launching and monitoring a child roslaunch process over SSH

Method __init__ No summary
Method getapi No summary
Method is_alive No summary
Method start Start the remote process. This will create an SSH connection to the remote host.
Method stop Terminate this process, including the SSH connection.
Instance Variable is_dead Undocumented
Instance Variable machine Undocumented
Instance Variable master_uri Undocumented
Instance Variable sigint_timeout Undocumented
Instance Variable sigterm_timeout Undocumented
Instance Variable ssh Undocumented
Instance Variable ssherr Undocumented
Instance Variable sshin Undocumented
Instance Variable sshout Undocumented
Instance Variable started Undocumented
Instance Variable uri Undocumented
Method _ssh_exec No summary
def __init__(self, run_id, name, server_uri, machine, master_uri=None, sigint_timeout=DEFAULT_TIMEOUT_SIGINT, sigterm_timeout=DEFAULT_TIMEOUT_SIGTERM):
Parameters
run_idUndocumented
nameUndocumented
server_uriUndocumented
machineMachine instance. Must be fully configured. machine.env_loader is required to be set.
master_uriUndocumented
sigint_timeout:floatThe SIGINT timeout used when killing nodes (in seconds).
sigterm_timeout:floatThe SIGTERM timeout used when killing nodes if SIGINT does not stop the node (in seconds).
def getapi(self):
Returns
ServerProxy to remote client XMLRPC server, ServerProxy
def is_alive(self):
Returns
True if the process is alive. is_alive needs to be called periodically as it drains the SSH buffer, bool
def start(self):

Start the remote process. This will create an SSH connection to the remote host.

def stop(self, errors=None):

Terminate this process, including the SSH connection.

is_dead: bool =

Undocumented

machine =

Undocumented

master_uri =

Undocumented

sigint_timeout =

Undocumented

sigterm_timeout =

Undocumented

ssh =

Undocumented

ssherr =

Undocumented

sshin =

Undocumented

sshout =

Undocumented

started: bool =

Undocumented

uri =

Undocumented

def _ssh_exec(self, command, address, port, username=None, password=None):
Returns
(ssh pipes, message). If error occurs, returns (None, error message).