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

Client side of the administrative commands defined in PortCoreMsgs.thrift and handled by PortCore::adminBlock() of a remote port. More...

#include <yarp/os/impl/PortCoreClient.h>

+ Inheritance diagram for yarp::os::impl::PortCoreClient:

Public Member Functions

 PortCoreClient (const std::string &remoteportName, double timeout=2.0)
 
 PortCoreClient (const yarp::os::Contact &remotePort, const yarp::os::ContactStyle &style)
 
 PortCoreClient (yarp::os::UnbufferedContactable &adminPort)
 Send the commands through a port which is already connected to the remote port and is in admin mode (see yarp::os::Port::setAdminMode).
 
 PortCoreClient (const PortCoreClient &)=delete
 
PortCoreClient & operator= (const PortCoreClient &)=delete
 
- Public Member Functions inherited from yarp::os::PortCoreMsgs
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

Client side of the administrative commands defined in PortCoreMsgs.thrift and handled by PortCore::adminBlock() of a remote port.

Definition at line 24 of file PortCoreClient.h.

Constructor & Destructor Documentation

◆ PortCoreClient() [1/4]

PortCoreClient::PortCoreClient ( const std::string &  remoteportName,
double  timeout = 2.0 
)
explicit

Definition at line 30 of file PortCoreClient.cpp.

◆ PortCoreClient() [2/4]

PortCoreClient::PortCoreClient ( const yarp::os::Contact &  remotePort,
const yarp::os::ContactStyle &  style 
)
Parameters
remotePortthe contact of the remote port
stylethe style of the connection used to send the commands (the admin flag is always set)

Definition at line 36 of file PortCoreClient.cpp.

◆ PortCoreClient() [3/4]

PortCoreClient::PortCoreClient ( yarp::os::UnbufferedContactable &  adminPort)
explicit

Send the commands through a port which is already connected to the remote port and is in admin mode (see yarp::os::Port::setAdminMode).

Definition at line 42 of file PortCoreClient.cpp.

◆ PortCoreClient() [4/4]

yarp::os::impl::PortCoreClient::PortCoreClient ( const PortCoreClient &  )
delete

Member Function Documentation

◆ operator=()

PortCoreClient & yarp::os::impl::PortCoreClient::operator= ( const PortCoreClient &  )
delete

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