YARP
Yet Another Robot Platform
yarp::run::Run Class Reference

#include <yarp/run/Run.h>

Static Public Member Functions

static int start (const std::string &node, yarp::os::Property &command, std::string &keyv)
 Launch a yarprun server. More...
 
static int sigterm (const std::string &node, const std::string &keyv)
 Terminate an application running on a yarprun server. More...
 
static int sigterm (const std::string &node)
 Terminate all applications running on a yarprun server. More...
 
static int kill (const std::string &node, const std::string &keyv, int s)
 Send a SIGNAL to an application running on a yarprun server (Linux only). More...
 
static bool isRunning (const std::string &node, std::string &keyv)
 Get a report of all applications running on a yarprun server. More...
 
static int client (yarp::os::Property &config)
 Send a property object to a run server, bundling up all the settings usually specified on the command line. More...
 

Detailed Description

Definition at line 81 of file Run.h.

Member Function Documentation

◆ client()

int yarp::run::Run::client ( yarp::os::Property config)
static

Send a property object to a run server, bundling up all the settings usually specified on the command line.

See the documentation for the "yarprun" command.

Parameters
configthe property object to send.
Returns
0 on success, -1 on failure

Definition at line 1235 of file Run.cpp.

◆ isRunning()

bool yarp::run::Run::isRunning ( const std::string &  node,
std::string &  keyv 
)
static

Get a report of all applications running on a yarprun server.

Parameters
nodeis the yarprun server port name. It must be unique in the network.
processesis a list of applications running on the remote yarprun server. It must not be allocated and it is responsibility of the caller to delete it.
num_processesreturn the number of running processes.
Returns
0=success -1=failed. Report if an application is still running on a yarprun server.
Parameters
nodeis the yarprun server port name. It must be unique in the network.
keyvis the tag that identifies the application. It must be unique in the network.
Returns
true=running false=terminated.

Definition at line 3761 of file Run.cpp.

◆ kill()

int yarp::run::Run::kill ( const std::string &  node,
const std::string &  keyv,
int  s 
)
static

Send a SIGNAL to an application running on a yarprun server (Linux only).

Parameters
nodeis the yarprun server port name. It must be unique in the network.
keyvis the tag that identifies the running application. It must be unique in the network.
sis the SIGNAL number.
Returns
0=success -1=failed.

Definition at line 3739 of file Run.cpp.

◆ sigterm() [1/2]

int yarp::run::Run::sigterm ( const std::string &  node)
static

Terminate all applications running on a yarprun server.

Parameters
nodeis the yarprun server port name. It must be unique in the network.
Returns
0=success -1=failed.

Definition at line 3719 of file Run.cpp.

◆ sigterm() [2/2]

int yarp::run::Run::sigterm ( const std::string &  node,
const std::string &  keyv 
)
static

Terminate an application running on a yarprun server.

Parameters
nodeis the yarprun server port name. It must be unique in the network.
keyvis the tag that identifies the running application. It must be unique in the network.
Returns
0=success -1=failed.

Definition at line 3698 of file Run.cpp.

◆ start()

int yarp::run::Run::start ( const std::string &  node,
yarp::os::Property command,
std::string &  keyv 
)
static

Launch a yarprun server.

Parameters
nodeis the yarprun server port name. It must be unique in the network.
commandis the command to be executed by the remote server. It can include an argument list and different options, in the standard yarp Property key/value mode:
  • name COMMAND_NAME
  • parameters ARGUMENT_LIST (optional)
  • stdio /SERVERPORT (optional)
  • geometry WxH+X+Y (optional)
  • hold (optional)
keyvis the tag that will identify the running application. It must be unique in the network.
Returns
0=success -1=failed.

Definition at line 3640 of file Run.cpp.


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