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 ¶ms) |
| Set the parameters of the portmonitor plug-in attached to the output of this port. | |
| virtual return_setPortmonitorParams | setPortmonitorParamsIn (const std::string ¶ms) |
| 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 ¶ms) |
| 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 ¶ms) |
| 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 |
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.
| yarp::os::PortCoreMsgs::PortCoreMsgs | ( | ) |
Definition at line 5556 of file PortCoreMsgs.cpp.
|
virtual |
Add an output connection from this port to another port.
| portname | the destination port of the connection |
| carrier | the carrier of the connection, e.g. tcp, udp, fast_tcp (optional, the default carrier is used if empty) |
Definition at line 5561 of file PortCoreMsgs.cpp.
Attach a portmonitor plug-in to the input of this port (it replaces the one previously attached, if any).
| prop | the portmonitor configuration, in yarp::os::Property format, e.g. "(type dll) (file test_numbers1)" or "(context yarpviz) (file portrate)" |
Definition at line 5591 of file PortCoreMsgs.cpp.
Attach a portmonitor plug-in to the output of this port (it replaces the one previously attached, if any).
| prop | the portmonitor configuration, in yarp::os::Property format, e.g. "(type dll) (file test_numbers1)" or "(context yarpviz) (file portrate)" |
Definition at line 5581 of file PortCoreMsgs.cpp.
|
virtual |
Definition at line 83 of file PortCoreMsgs.cpp.
|
virtual |
Remove all the input and output connections between this port and another port.
| portname | the port at the other end of the connection(s) |
Definition at line 5571 of file PortCoreMsgs.cpp.
|
virtual |
Detach the portmonitor plug-in from the input of this port.
Definition at line 5611 of file PortCoreMsgs.cpp.
|
virtual |
Detach the portmonitor plug-in from the output of this port.
Definition at line 5601 of file PortCoreMsgs.cpp.
|
virtual |
Report the version of the administrative protocol of this port (it is distinct from the version of the YARP library).
Definition at line 5741 of file PortCoreMsgs.cpp.
|
virtual |
Give details about the input connection coming from another port to this port.
| portname | the source port of the connection |
Definition at line 5721 of file PortCoreMsgs.cpp.
|
virtual |
Give details about the output connection going from this port to another port.
| portname | the destination port of the connection |
Definition at line 5731 of file PortCoreMsgs.cpp.
|
virtual |
Get the carrier parameters of the input connection coming from another port to this port.
| portname | the source port of the connection |
Definition at line 5691 of file PortCoreMsgs.cpp.
|
virtual |
Get the carrier parameters of the output connection going from this port to another port.
| portname | the destination port of the connection |
Definition at line 5681 of file PortCoreMsgs.cpp.
|
virtual |
Get the quality of service of the input connection coming from another port to this port.
| portname | the source port of the connection |
Definition at line 5761 of file PortCoreMsgs.cpp.
|
virtual |
Get the quality of service of the output connection going from this port to another port.
| portname | the destination port of the connection |
Definition at line 5771 of file PortCoreMsgs.cpp.
|
virtual |
Definition at line 98 of file PortCoreMsgs.cpp.
|
virtual |
Give information about this port, its main thread, and the process and the platform on which it is running.
Definition at line 5751 of file PortCoreMsgs.cpp.
|
virtual |
Get the parameters of the portmonitor plug-in attached to the input of this port.
Definition at line 5651 of file PortCoreMsgs.cpp.
|
virtual |
Get the parameters of the portmonitor plug-in attached to the output of this port.
Definition at line 5641 of file PortCoreMsgs.cpp.
|
virtual |
Definition at line 68 of file PortCoreMsgs.cpp.
|
virtual |
Definition at line 5812 of file PortCoreMsgs.cpp.
|
virtual |
List the ports connected to the input of this port.
Definition at line 5701 of file PortCoreMsgs.cpp.
|
virtual |
List the ports connected to the output of this port.
Definition at line 5711 of file PortCoreMsgs.cpp.
|
overridevirtual |
Read this object from a network connection.
Override this for your particular class.
| reader | an interface to the network connection for reading |
Implements yarp::os::PortReader.
Definition at line 5959 of file PortCoreMsgs.cpp.
|
virtual |
Set the carrier parameters of the input connection coming from another port to this port.
| portname | the source port of the connection |
| params | the parameters, in yarp::os::Property format; their meaning depends on the carrier of the connection |
Definition at line 5671 of file PortCoreMsgs.cpp.
|
virtual |
Set the carrier parameters of the output connection going from this port to another port.
| portname | the destination port of the connection |
| params | the parameters, in yarp::os::Property format; their meaning depends on the carrier of the connection |
Definition at line 5661 of file PortCoreMsgs.cpp.
|
virtual |
Set the quality of service of the input connection coming from another port to this port.
| portname | the source port of the connection |
| scheduler_priority | the scheduling priority of the thread which handles the connection (OS specific; -1 leaves the scheduling of the thread unchanged) |
| scheduler_policy | the 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_tos | the 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) |
Definition at line 5781 of file PortCoreMsgs.cpp.
|
virtual |
Set the quality of service of the output connection going from this port to another port.
| portname | the destination port of the connection |
| scheduler_priority | the scheduling priority of the thread which handles the connection (OS specific; -1 leaves the scheduling of the thread unchanged) |
| scheduler_policy | the 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_tos | the 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) |
Definition at line 5791 of file PortCoreMsgs.cpp.
|
virtual |
Set the parameters of the portmonitor plug-in attached to the input of this port.
| params | the parameters, in yarp::os::Property format, e.g. "(log_save 1)"; their meaning depends on the portmonitor |
Definition at line 5631 of file PortCoreMsgs.cpp.
|
virtual |
Set the parameters of the portmonitor plug-in attached to the output of this port.
| params | the parameters, in yarp::os::Property format, e.g. "(log_save 1)"; their meaning depends on the portmonitor |
Definition at line 5621 of file PortCoreMsgs.cpp.
|
virtual |
Set the scheduling parameters of all the threads of the process which owns this port.
| priority | the scheduling priority (OS specific) |
| policy | the scheduling policy (OS specific, e.g. on Linux 0 = SCHED_OTHER, 1 = SCHED_FIFO, 2 = SCHED_RR) |
Definition at line 5801 of file PortCoreMsgs.cpp.