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

Administrative commands of a YARP port, handled by PortCore::adminBlock(). More...

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

+ Inheritance diagram for yarp::os::PortCoreMsgs:

Public Member Functions

virtual yarp::os::ApplicationNetworkProtocolVersion getLocalProtocolVersion ()
 
virtual yarp::os::ApplicationNetworkProtocolVersion getRemoteProtocolVersion ()
 
virtual bool checkProtocolVersion ()
 
 PortCoreMsgs ()
 
virtual return_addConnection addConnection (const std::string &portname, const std::string &carrier="")
 Add an output connection from this port to another port.
 
virtual return_delConnection delConnection (const std::string &portname)
 Remove all the input and output connections between this port and another port.
 
virtual bool attachPortmonitorOut (const std::string &prop)
 Attach a portmonitor plug-in to the output of this port (it replaces the one previously attached, if any).
 
virtual bool attachPortmonitorIn (const std::string &prop)
 Attach a portmonitor plug-in to the input of this port (it replaces the one previously attached, if any).
 
virtual bool detachPortmonitorOut ()
 Detach the portmonitor plug-in from the output of this port.
 
virtual bool detachPortmonitorIn ()
 Detach the portmonitor plug-in from the input of this port.
 
virtual return_setPortmonitorParams setPortmonitorParamsOut (const std::string &params)
 Set the parameters of the portmonitor plug-in attached to the output of this port.
 
virtual return_setPortmonitorParams setPortmonitorParamsIn (const std::string &params)
 Set the parameters of the portmonitor plug-in attached to the input of this port.
 
virtual return_getPortmonitorParams getPortmonitorParamsOut ()
 Get the parameters of the portmonitor plug-in attached to the output of this port.
 
virtual return_getPortmonitorParams getPortmonitorParamsIn ()
 Get the parameters of the portmonitor plug-in attached to the input of this port.
 
virtual return_setConnectionParams setConnectionParamsOut (const std::string &portname, const std::string &params)
 Set the carrier parameters of the output connection going from this port to another port.
 
virtual return_setConnectionParams setConnectionParamsIn (const std::string &portname, const std::string &params)
 Set the carrier parameters of the input connection coming from another port to this port.
 
virtual return_getConnectionParams getConnectionParamsOut (const std::string &portname)
 Get the carrier parameters of the output connection going from this port to another port.
 
virtual return_getConnectionParams getConnectionParamsIn (const std::string &portname)
 Get the carrier parameters of the input connection coming from another port to this port.
 
virtual return_listConnections listConnectionsIn ()
 List the ports connected to the input of this port.
 
virtual return_listConnections listConnectionsOut ()
 List the ports connected to the output of this port.
 
virtual return_getConnectionInfo getConnectionInfoIn (const std::string &portname)
 Give details about the input connection coming from another port to this port.
 
virtual return_getConnectionInfo getConnectionInfoOut (const std::string &portname)
 Give details about the output connection going from this port to another port.
 
virtual return_getAdminProtocolVersion getAdminProtocolVersion ()
 Report the version of the administrative protocol of this port (it is distinct from the version of the YARP library).
 
virtual return_getPortInfo getPortInfo ()
 Give information about this port, its main thread, and the process and the platform on which it is running.
 
virtual return_getConnectionQos getConnectionQosIn (const std::string &portname)
 Get the quality of service of the input connection coming from another port to this port.
 
virtual return_getConnectionQos getConnectionQosOut (const std::string &portname)
 Get the quality of service of the output connection going from this port to another port.
 
virtual return_setConnectionQos setConnectionQosIn (const std::string &portname, const std::int32_t scheduler_priority, const std::int32_t scheduler_policy, const std::int32_t qos_tos)
 Set the quality of service of the input connection coming from another port to this port.
 
virtual return_setConnectionQos setConnectionQosOut (const std::string &portname, const std::int32_t scheduler_priority, const std::int32_t scheduler_policy, const std::int32_t qos_tos)
 Set the quality of service of the output connection going from this port to another port.
 
virtual bool setProcessScheduling (const std::int32_t priority, const std::int32_t policy)
 Set the scheduling parameters of all the threads of the process which owns this port.
 
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

Administrative commands of a YARP port, handled by PortCore::adminBlock().

They can be sent with "yarp admin rpc /portname", or from code using yarp::os::impl::PortCoreClient.

Definition at line 40 of file PortCoreMsgs.h.

Constructor & Destructor Documentation

◆ PortCoreMsgs()

yarp::os::PortCoreMsgs::PortCoreMsgs ( )

Definition at line 5556 of file PortCoreMsgs.cpp.

Member Function Documentation

◆ addConnection()

return_addConnection yarp::os::PortCoreMsgs::addConnection ( const std::string &  portname,
const std::string &  carrier = "" 
)
virtual

Add an output connection from this port to another port.

Parameters
portnamethe destination port of the connection
carrierthe carrier of the connection, e.g. tcp, udp, fast_tcp (optional, the default carrier is used if empty)
Returns
success: true if the connection has been added; message: a description of the result

Definition at line 5561 of file PortCoreMsgs.cpp.

◆ attachPortmonitorIn()

bool yarp::os::PortCoreMsgs::attachPortmonitorIn ( const std::string &  prop)
virtual

Attach a portmonitor plug-in to the input of this port (it replaces the one previously attached, if any).

Parameters
propthe portmonitor configuration, in yarp::os::Property format, e.g. "(type dll) (file test_numbers1)" or "(context yarpviz) (file portrate)"
Returns
true if the portmonitor has been attached

Definition at line 5591 of file PortCoreMsgs.cpp.

◆ attachPortmonitorOut()

bool yarp::os::PortCoreMsgs::attachPortmonitorOut ( const std::string &  prop)
virtual

Attach a portmonitor plug-in to the output of this port (it replaces the one previously attached, if any).

Parameters
propthe portmonitor configuration, in yarp::os::Property format, e.g. "(type dll) (file test_numbers1)" or "(context yarpviz) (file portrate)"
Returns
true if the portmonitor has been attached

Definition at line 5581 of file PortCoreMsgs.cpp.

◆ checkProtocolVersion()

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

Definition at line 83 of file PortCoreMsgs.cpp.

◆ delConnection()

return_delConnection yarp::os::PortCoreMsgs::delConnection ( const std::string &  portname)
virtual

Remove all the input and output connections between this port and another port.

Parameters
portnamethe port at the other end of the connection(s)
Returns
success: true if at least one connection has been removed; message: a description of the result

Definition at line 5571 of file PortCoreMsgs.cpp.

◆ detachPortmonitorIn()

bool yarp::os::PortCoreMsgs::detachPortmonitorIn ( )
virtual

Detach the portmonitor plug-in from the input of this port.

Returns
true (also if no portmonitor was attached)

Definition at line 5611 of file PortCoreMsgs.cpp.

◆ detachPortmonitorOut()

bool yarp::os::PortCoreMsgs::detachPortmonitorOut ( )
virtual

Detach the portmonitor plug-in from the output of this port.

Returns
true (also if no portmonitor was attached)

Definition at line 5601 of file PortCoreMsgs.cpp.

◆ getAdminProtocolVersion()

return_getAdminProtocolVersion yarp::os::PortCoreMsgs::getAdminProtocolVersion ( )
virtual

Report the version of the administrative protocol of this port (it is distinct from the version of the YARP library).

Returns
version_major, version_minor, version_patch: the version of the protocol

Definition at line 5741 of file PortCoreMsgs.cpp.

◆ getConnectionInfoIn()

return_getConnectionInfo yarp::os::PortCoreMsgs::getConnectionInfoIn ( const std::string &  portname)
virtual

Give details about the input connection coming from another port to this port.

Parameters
portnamethe source port of the connection
Returns
found: false if there is no such connection; from_port, to_port: the ends of the connection; carrier: the carrier of the connection; connectionless: true if the carrier is connectionless (e.g. udp); push: false if the carrier is reversed (pull)

Definition at line 5721 of file PortCoreMsgs.cpp.

◆ getConnectionInfoOut()

return_getConnectionInfo yarp::os::PortCoreMsgs::getConnectionInfoOut ( const std::string &  portname)
virtual

Give details about the output connection going from this port to another port.

Parameters
portnamethe destination port of the connection
Returns
found: false if there is no such connection; from_port, to_port: the ends of the connection; carrier: the carrier of the connection; connectionless: true if the carrier is connectionless (e.g. udp); push: false if the carrier is reversed (pull)

Definition at line 5731 of file PortCoreMsgs.cpp.

◆ getConnectionParamsIn()

return_getConnectionParams yarp::os::PortCoreMsgs::getConnectionParamsIn ( const std::string &  portname)
virtual

Get the carrier parameters of the input connection coming from another port to this port.

Parameters
portnamethe source port of the connection
Returns
success: false if there is no such connection; params: the parameters, in yarp::os::Property format; message: a description of the error (if any)

Definition at line 5691 of file PortCoreMsgs.cpp.

◆ getConnectionParamsOut()

return_getConnectionParams yarp::os::PortCoreMsgs::getConnectionParamsOut ( const std::string &  portname)
virtual

Get the carrier parameters of the output connection going from this port to another port.

Parameters
portnamethe destination port of the connection
Returns
success: false if there is no such connection; params: the parameters, in yarp::os::Property format; message: a description of the error (if any)

Definition at line 5681 of file PortCoreMsgs.cpp.

◆ getConnectionQosIn()

return_getConnectionQos yarp::os::PortCoreMsgs::getConnectionQosIn ( const std::string &  portname)
virtual

Get the quality of service of the input connection coming from another port to this port.

Parameters
portnamethe source port of the connection
Returns
found: false if there is no such connection; thread: tid, scheduling priority and policy of the thread which handles the connection; qos_tos: the type of service of the packets of the connection (-1 if not available)

Definition at line 5761 of file PortCoreMsgs.cpp.

◆ getConnectionQosOut()

return_getConnectionQos yarp::os::PortCoreMsgs::getConnectionQosOut ( const std::string &  portname)
virtual

Get the quality of service of the output connection going from this port to another port.

Parameters
portnamethe destination port of the connection
Returns
found: false if there is no such connection; thread: tid, scheduling priority and policy of the thread which handles the connection; qos_tos: the type of service of the packets of the connection (-1 if not available)

Definition at line 5771 of file PortCoreMsgs.cpp.

◆ getLocalProtocolVersion()

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

Definition at line 98 of file PortCoreMsgs.cpp.

◆ getPortInfo()

return_getPortInfo yarp::os::PortCoreMsgs::getPortInfo ( )
virtual

Give information about this port, its main thread, and the process and the platform on which it is running.

Returns
process: name, arguments, scheduling policy and priority, pid of the process; platform: name, distribution, release, codename, kernel, environment variables of the operating system; thread: tid, priority, policy of the main thread of the port; port: is_input, is_output, is_rpc, type, hostname of the port

Definition at line 5751 of file PortCoreMsgs.cpp.

◆ getPortmonitorParamsIn()

return_getPortmonitorParams yarp::os::PortCoreMsgs::getPortmonitorParamsIn ( )
virtual

Get the parameters of the portmonitor plug-in attached to the input of this port.

Returns
success: false if no portmonitor is attached; params: the parameters, in yarp::os::Property format; message: a description of the error (if any)

Definition at line 5651 of file PortCoreMsgs.cpp.

◆ getPortmonitorParamsOut()

return_getPortmonitorParams yarp::os::PortCoreMsgs::getPortmonitorParamsOut ( )
virtual

Get the parameters of the portmonitor plug-in attached to the output of this port.

Returns
success: false if no portmonitor is attached; params: the parameters, in yarp::os::Property format; message: a description of the error (if any)

Definition at line 5641 of file PortCoreMsgs.cpp.

◆ getRemoteProtocolVersion()

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

Definition at line 68 of file PortCoreMsgs.cpp.

◆ help()

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

Definition at line 5812 of file PortCoreMsgs.cpp.

◆ listConnectionsIn()

return_listConnections yarp::os::PortCoreMsgs::listConnectionsIn ( )
virtual

List the ports connected to the input of this port.

Returns
connections: the names of the source ports of the input connections

Definition at line 5701 of file PortCoreMsgs.cpp.

◆ listConnectionsOut()

return_listConnections yarp::os::PortCoreMsgs::listConnectionsOut ( )
virtual

List the ports connected to the output of this port.

Returns
connections: the names of the destination ports of the output connections

Definition at line 5711 of file PortCoreMsgs.cpp.

◆ read()

bool yarp::os::PortCoreMsgs::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 5959 of file PortCoreMsgs.cpp.

◆ setConnectionParamsIn()

return_setConnectionParams yarp::os::PortCoreMsgs::setConnectionParamsIn ( const std::string &  portname,
const std::string &  params 
)
virtual

Set the carrier parameters of the input connection coming from another port to this port.

Parameters
portnamethe source port of the connection
paramsthe parameters, in yarp::os::Property format; their meaning depends on the carrier of the connection
Returns
success: false if there is no such connection; message: a description of the result

Definition at line 5671 of file PortCoreMsgs.cpp.

◆ setConnectionParamsOut()

return_setConnectionParams yarp::os::PortCoreMsgs::setConnectionParamsOut ( const std::string &  portname,
const std::string &  params 
)
virtual

Set the carrier parameters of the output connection going from this port to another port.

Parameters
portnamethe destination port of the connection
paramsthe parameters, in yarp::os::Property format; their meaning depends on the carrier of the connection
Returns
success: false if there is no such connection; message: a description of the result

Definition at line 5661 of file PortCoreMsgs.cpp.

◆ setConnectionQosIn()

return_setConnectionQos yarp::os::PortCoreMsgs::setConnectionQosIn ( const std::string &  portname,
const std::int32_t  scheduler_priority,
const std::int32_t  scheduler_policy,
const std::int32_t  qos_tos 
)
virtual

Set the quality of service of the input connection coming from another port to this port.

Parameters
portnamethe source port of the connection
scheduler_prioritythe scheduling priority of the thread which handles the connection (OS specific; -1 leaves the scheduling of the thread unchanged)
scheduler_policythe scheduling policy of the thread which handles the connection (OS specific, e.g. on Linux 0 = SCHED_OTHER, 1 = SCHED_FIFO, 2 = SCHED_RR)
qos_tosthe type of service of the packets of the connection, e.g. LOW = 40, NORMAL = 0, HIGH = 144, CRITICAL = 176 (a negative value leaves it unchanged)
Returns
success: false if there is no such connection or if the qos could not be set; message: a description of the error (if any)

Definition at line 5781 of file PortCoreMsgs.cpp.

◆ setConnectionQosOut()

return_setConnectionQos yarp::os::PortCoreMsgs::setConnectionQosOut ( const std::string &  portname,
const std::int32_t  scheduler_priority,
const std::int32_t  scheduler_policy,
const std::int32_t  qos_tos 
)
virtual

Set the quality of service of the output connection going from this port to another port.

Parameters
portnamethe destination port of the connection
scheduler_prioritythe scheduling priority of the thread which handles the connection (OS specific; -1 leaves the scheduling of the thread unchanged)
scheduler_policythe scheduling policy of the thread which handles the connection (OS specific, e.g. on Linux 0 = SCHED_OTHER, 1 = SCHED_FIFO, 2 = SCHED_RR)
qos_tosthe type of service of the packets of the connection, e.g. LOW = 40, NORMAL = 0, HIGH = 144, CRITICAL = 176 (a negative value leaves it unchanged)
Returns
success: false if there is no such connection or if the qos could not be set; message: a description of the error (if any)

Definition at line 5791 of file PortCoreMsgs.cpp.

◆ setPortmonitorParamsIn()

return_setPortmonitorParams yarp::os::PortCoreMsgs::setPortmonitorParamsIn ( const std::string &  params)
virtual

Set the parameters of the portmonitor plug-in attached to the input of this port.

Parameters
paramsthe parameters, in yarp::os::Property format, e.g. "(log_save 1)"; their meaning depends on the portmonitor
Returns
success: false if no portmonitor is attached; message: a description of the error (if any)

Definition at line 5631 of file PortCoreMsgs.cpp.

◆ setPortmonitorParamsOut()

return_setPortmonitorParams yarp::os::PortCoreMsgs::setPortmonitorParamsOut ( const std::string &  params)
virtual

Set the parameters of the portmonitor plug-in attached to the output of this port.

Parameters
paramsthe parameters, in yarp::os::Property format, e.g. "(log_save 1)"; their meaning depends on the portmonitor
Returns
success: false if no portmonitor is attached; message: a description of the error (if any)

Definition at line 5621 of file PortCoreMsgs.cpp.

◆ setProcessScheduling()

bool yarp::os::PortCoreMsgs::setProcessScheduling ( const std::int32_t  priority,
const std::int32_t  policy 
)
virtual

Set the scheduling parameters of all the threads of the process which owns this port.

Parameters
prioritythe scheduling priority (OS specific)
policythe scheduling policy (OS specific, e.g. on Linux 0 = SCHED_OTHER, 1 = SCHED_FIFO, 2 = SCHED_RR)
Returns
true if the scheduling parameters have been set

Definition at line 5801 of file PortCoreMsgs.cpp.


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