YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::os::TerminatorMsgs Class Reference

Commands accepted by the port opened by yarp::os::Terminee, and sent by yarp::os::Terminator::terminateByName(). More...

#include <idl_generated_code/yarp/os/TerminatorMsgs.h>

+ Inheritance diagram for yarp::os::TerminatorMsgs:

Public Member Functions

virtual yarp::os::ApplicationNetworkProtocolVersion getLocalProtocolVersion ()
 
virtual yarp::os::ApplicationNetworkProtocolVersion getRemoteProtocolVersion ()
 
virtual bool checkProtocolVersion ()
 
 TerminatorMsgs ()
 
virtual bool quit ()
 Ask the process which owns the port to start a graceful quit procedure.
 
virtual std::vector< std::string > help (const std::string &functionName="--all")
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection.
 
- Public Member Functions inherited from yarp::os::Wire
yarp::os::WireLink & yarp ()
 Get YARP state associated with this object.
 
const yarp::os::WireLink & yarp () const
 Get YARP state associated with this object (const version).
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor.
 
virtual Type getReadType () const
 

Detailed Description

Commands accepted by the port opened by yarp::os::Terminee, and sent by yarp::os::Terminator::terminateByName().

They can also be sent with "yarp rpc /portname/quit".

Definition at line 28 of file TerminatorMsgs.h.

Constructor & Destructor Documentation

◆ TerminatorMsgs()

yarp::os::TerminatorMsgs::TerminatorMsgs ( )

Definition at line 306 of file TerminatorMsgs.cpp.

Member Function Documentation

◆ checkProtocolVersion()

bool yarp::os::TerminatorMsgs::checkProtocolVersion ( )
virtual

Definition at line 83 of file TerminatorMsgs.cpp.

◆ getLocalProtocolVersion()

yarp::os::ApplicationNetworkProtocolVersion yarp::os::TerminatorMsgs::getLocalProtocolVersion ( )
virtual

Definition at line 98 of file TerminatorMsgs.cpp.

◆ getRemoteProtocolVersion()

yarp::os::ApplicationNetworkProtocolVersion yarp::os::TerminatorMsgs::getRemoteProtocolVersion ( )
virtual

Definition at line 68 of file TerminatorMsgs.cpp.

◆ help()

std::vector< std::string > yarp::os::TerminatorMsgs::help ( const std::string &  functionName = "--all")
virtual

Definition at line 322 of file TerminatorMsgs.cpp.

◆ quit()

bool yarp::os::TerminatorMsgs::quit ( )
virtual

Ask the process which owns the port to start a graceful quit procedure.

Returns
true if the request has been accepted

Definition at line 311 of file TerminatorMsgs.cpp.

◆ read()

bool yarp::os::TerminatorMsgs::read ( yarp::os::ConnectionReader &  reader)
overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::PortReader.

Definition at line 349 of file TerminatorMsgs.cpp.


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