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

config

the property object to send.

Returns

0 on success, -1 on failure

Definition at line 1236 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

node	is the yarprun server port name. It must be unique in the network.
processes	is 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_processes	return the number of running processes.

Returns

0=success -1=failed. Report if an application is still running on a yarprun server.

Parameters

node	is the yarprun server port name. It must be unique in the network.
keyv	is the tag that identifies the application. It must be unique in the network.

Returns

true=running false=terminated.

Definition at line 3762 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

node	is the yarprun server port name. It must be unique in the network.
keyv	is the tag that identifies the running application. It must be unique in the network.
s	is the SIGNAL number.

Returns

0=success -1=failed.

Definition at line 3740 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

node	is the yarprun server port name. It must be unique in the network.

Returns

0=success -1=failed.

Definition at line 3720 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

node	is the yarprun server port name. It must be unique in the network.
keyv	is the tag that identifies the running application. It must be unique in the network.

Returns

0=success -1=failed.

Definition at line 3699 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

node	is the yarprun server port name. It must be unique in the network.
command	is 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)
keyv	is the tag that will identify the running application. It must be unique in the network.

Returns

0=success -1=failed.

Definition at line 3641 of file Run.cpp.

---

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

• src/libYARP_run/src/yarp/run/Run.h
• src/libYARP_run/src/yarp/run/Run.cpp