YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::os::PortCoreMsgs_setConnectionQosIn_helper Class Reference
+ Inheritance diagram for yarp::os::PortCoreMsgs_setConnectionQosIn_helper:

Classes

class  Command
 
class  Reply
 

Public Types

using funcptr_t = return_setConnectionQos(*)(const std::string &, const std::int32_t, const std::int32_t, const std::int32_t)
 

Public Member Functions

 PortCoreMsgs_setConnectionQosIn_helper ()=default
 
 PortCoreMsgs_setConnectionQosIn_helper (const std::string &portname, const std::int32_t scheduler_priority, const std::int32_t scheduler_policy, const std::int32_t qos_tos)
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection.
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection.
 
void call (PortCoreMsgs *ptr)
 
- Public Member Functions inherited from yarp::os::Portable
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor.
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor.
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations.
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations.
 
virtual yarp::os::Type getWriteType () const
 

Public Attributes

Command cmd
 
Reply reply
 

Static Public Attributes

static constexpr const char * s_tag {"setConnectionQosIn"}
 
static constexpr size_t s_tag_len {1}
 
static constexpr size_t s_cmd_len {5}
 
static constexpr size_t s_reply_len {3}
 
static constexpr const char * s_prototype {"return_setConnectionQos PortCoreMsgs::setConnectionQosIn(const std::string& portname, const std::int32_t scheduler_priority, const std::int32_t scheduler_policy, const std::int32_t qos_tos)"}
 
static constexpr const char * s_help
 

Additional Inherited Members

- Static Public Member Functions inherited from yarp::os::Portable
static bool copyPortable (const PortWriter &writer, PortReader &reader)
 Copy one portable to another, via writing and reading.
 

Detailed Description

Definition at line 1544 of file PortCoreMsgs.cpp.

Member Typedef Documentation

◆ funcptr_t

Definition at line 1595 of file PortCoreMsgs.cpp.

Constructor & Destructor Documentation

◆ PortCoreMsgs_setConnectionQosIn_helper() [1/2]

yarp::os::PortCoreMsgs_setConnectionQosIn_helper::PortCoreMsgs_setConnectionQosIn_helper ( )
default

◆ PortCoreMsgs_setConnectionQosIn_helper() [2/2]

yarp::os::PortCoreMsgs_setConnectionQosIn_helper::PortCoreMsgs_setConnectionQosIn_helper ( const std::string &  portname,
const std::int32_t  scheduler_priority,
const std::int32_t  scheduler_policy,
const std::int32_t  qos_tos 
)

Definition at line 5010 of file PortCoreMsgs.cpp.

Member Function Documentation

◆ call()

void yarp::os::PortCoreMsgs_setConnectionQosIn_helper::call ( PortCoreMsgs *  ptr)

Definition at line 5194 of file PortCoreMsgs.cpp.

◆ read()

bool yarp::os::PortCoreMsgs_setConnectionQosIn_helper::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::Portable.

Definition at line 5020 of file PortCoreMsgs.cpp.

◆ write()

bool yarp::os::PortCoreMsgs_setConnectionQosIn_helper::write ( yarp::os::ConnectionWriter &  writer) const
overridevirtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters
writeran interface to the network connection for writing
Returns
true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 5015 of file PortCoreMsgs.cpp.

Member Data Documentation

◆ cmd

Command yarp::os::PortCoreMsgs_setConnectionQosIn_helper::cmd

Definition at line 1598 of file PortCoreMsgs.cpp.

◆ reply

Reply yarp::os::PortCoreMsgs_setConnectionQosIn_helper::reply

Definition at line 1599 of file PortCoreMsgs.cpp.

◆ s_cmd_len

constexpr size_t yarp::os::PortCoreMsgs_setConnectionQosIn_helper::s_cmd_len {5}
staticconstexpr

Definition at line 1603 of file PortCoreMsgs.cpp.

◆ s_help

constexpr const char* yarp::os::PortCoreMsgs_setConnectionQosIn_helper::s_help
staticconstexpr
Initial value:
{
"Set the quality of service of the input connection coming from another port to this port.\n"
"@param portname the source port of the connection\n"
"@param scheduler_priority the scheduling priority of the thread which handles the connection (OS specific; -1 leaves the scheduling of the thread unchanged)\n"
"@param 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)\n"
"@param 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)\n"
"@return 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 1606 of file PortCoreMsgs.cpp.

◆ s_prototype

constexpr const char* yarp::os::PortCoreMsgs_setConnectionQosIn_helper::s_prototype {"return_setConnectionQos PortCoreMsgs::setConnectionQosIn(const std::string& portname, const std::int32_t scheduler_priority, const std::int32_t scheduler_policy, const std::int32_t qos_tos)"}
staticconstexpr

Definition at line 1605 of file PortCoreMsgs.cpp.

◆ s_reply_len

constexpr size_t yarp::os::PortCoreMsgs_setConnectionQosIn_helper::s_reply_len {3}
staticconstexpr

Definition at line 1604 of file PortCoreMsgs.cpp.

◆ s_tag

constexpr const char* yarp::os::PortCoreMsgs_setConnectionQosIn_helper::s_tag {"setConnectionQosIn"}
staticconstexpr

Definition at line 1601 of file PortCoreMsgs.cpp.

◆ s_tag_len

constexpr size_t yarp::os::PortCoreMsgs_setConnectionQosIn_helper::s_tag_len {1}
staticconstexpr

Definition at line 1602 of file PortCoreMsgs.cpp.


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