#include <yarp/run/Run.h>
|
| static bool | start (const std::string &node, yarp::os::Property &command, std::string &keyv) |
| | Launch a yarprun server.
|
| |
| static bool | sigterm (const std::string &node, const std::string &keyv) |
| | Terminate an application running on a yarprun server.
|
| |
| static bool | sigtermall (const std::string &node) |
| | Terminate all applications running on a yarprun server.
|
| |
| static bool | kill (const std::string &node, const std::string &keyv, int s) |
| | Send a SIGNAL to an application running on a yarprun server (Linux only).
|
| |
| static bool | ps (const std::string &node, std::vector< processInfo > &processes) |
| | Get a report of all applications running on a yarprun server.
|
| |
| static bool | sysinfo (const std::string &node, yarp::os::SystemInfoSerializer &info) |
| | Get a report of system information of a yarprun server.
|
| |
| static bool | isRunning (const std::string &node, const std::string &keyv) |
| | Report if an application is still running on a yarprun server.
|
| |
| static bool | which (const std::string &node, const std::string &keyv) |
| | Display the path of a file on a yarprun server.
|
| |
| static bool | exit (const std::string &node) |
| | Exit a yarprun server.
|
| |
| 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.
|
| |
Definition at line 80 of file Run.h.
◆ client()
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 38 of file RunClient.cpp.
◆ exit()
| bool yarp::run::Run::exit |
( |
const std::string & |
node | ) |
|
|
static |
Exit a yarprun server.
- Parameters
-
| node | is the yarprun server port name. It must be unique in the network. |
- Returns
- true=success false=failed.
Definition at line 636 of file RunClient.cpp.
◆ isRunning()
| bool yarp::run::Run::isRunning |
( |
const std::string & |
node, |
|
|
const std::string & |
keyv |
|
) |
| |
|
static |
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 386 of file RunClient.cpp.
◆ kill()
| bool 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
- true=success false=failed.
Definition at line 558 of file RunClient.cpp.
◆ ps()
| bool yarp::run::Run::ps |
( |
const std::string & |
node, |
|
|
std::vector< processInfo > & |
processes |
|
) |
| |
|
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. |
- Returns
- 0=success -1=failed.
Definition at line 580 of file RunClient.cpp.
◆ sigterm()
| bool 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
- true=success false=failed.
Definition at line 517 of file RunClient.cpp.
◆ sigtermall()
| bool yarp::run::Run::sigtermall |
( |
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
- true=success false=failed.
Definition at line 538 of file RunClient.cpp.
◆ start()
| bool 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
- true=success false=failed.
Definition at line 459 of file RunClient.cpp.
◆ sysinfo()
Get a report of system information of a yarprun server.
- Parameters
-
| node | is the yarprun server port name. It must be unique in the network. |
| info | is the system information of the remote yarprun server. |
- Returns
- true=success false=failed.
Definition at line 412 of file RunClient.cpp.
◆ which()
| bool yarp::run::Run::which |
( |
const std::string & |
node, |
|
|
const std::string & |
keyv |
|
) |
| |
|
static |
Display the path of a file 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 611 of file RunClient.cpp.
The documentation for this class was generated from the following files: