YARP  2.3.68+225-20170329.5+gitb0d3289
Yet Another Robot Platform
yarp::os::Terminator Class Reference

Send a message to a process that has a corresponding socket port created using the Terminee class to ask to start a graceful quit procedure. More...

#include <yarp/os/Terminator.h>

Static Public Member Functions

static bool terminateByName (const char *name)
 Send a quit message to a specific socket port. More...
 

Detailed Description

Send a message to a process that has a corresponding socket port created using the Terminee class to ask to start a graceful quit procedure.

The receiving process must collaborate and take appropriate action after receiving the message. The Terminator/Terminee class pair starts a tcp socket on the server side listening for incoming connections and the magic word "quit" (all lowercase). The ip-port pair is registered with a symbolic name on the Yarp name server and can be queried by the client to send the termination message.

Definition at line 35 of file Terminator.h.

Member Function Documentation

◆ terminateByName()

bool Terminator::terminateByName ( const char *  name)
static

Send a quit message to a specific socket port.

Parameters
nameis the name of the socket port (as registered in the name server).
Returns
true/false on success/failure.

Definition at line 22 of file Terminator.cpp.


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