Package roslaunch :: Module remoteprocess :: Class SSHChildROSLaunchProcess

Class SSHChildROSLaunchProcess

              object --+        
                       |        
            pmon.Process --+    
                           |    
server.ChildROSLaunchProcess --+
                               |
                              SSHChildROSLaunchProcess

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

Instance Methods

__init__(self, run_id, name, server_uri, machine, master_uri=None)
:param machine: Machine instance.

source code

start(self)
Start the remote process.

source code

getapi(self)
:returns: ServerProxy to remote client XMLRPC server, `ServerProxy`

source code

is_alive(self)
:returns: ``True`` if the process is alive.

source code

stop(self, errors=None)
Terminate this process, including the SSH connection.

source code

__str__(self)
str(x) (Inherited from roslaunch.pmon.Process)

source code

get_exit_description(self) (Inherited from roslaunch.pmon.Process)

source code

dict { str: val }

get_info(self)
Get all data about this process in dictionary form (Inherited from roslaunch.pmon.Process)

source code

set_uri(self, uri) (Inherited from roslaunch.server.ChildROSLaunchProcess)

source code

should_respawn(self)
Returns: False if process should not respawn floating point seconds until respawn otherwise (Inherited from roslaunch.pmon.Process)

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

init(self, run_id, name, server_uri, machine, master_uri=None)
(Constructor)

source code


:param machine: Machine instance. Must be fully configured.
    machine.env_loader is required to be set.

Overrides: object.__init__

start(self)

source code

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

Overrides: pmon.Process.start

is_alive(self)

source code


:returns: ``True`` if the process is alive. is_alive needs to be
    called periodically as it drains the SSH buffer, ``bool``

Overrides: pmon.Process.is_alive

stop(self, errors=None)

source code

Terminate this process, including the SSH connection.

Parameters:

errors - error messages. stop() will record messages into this list.

Overrides: pmon.Process.stop

Class SSHChildROSLaunchProcess

__init__(self, run_id, name, server_uri, machine, master_uri=None) (Constructor)

start(self)

is_alive(self)

stop(self, errors=None)

init(self, run_id, name, server_uri, machine, master_uri=None)
(Constructor)