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

Classes

class  Command
 
class  Reply
 

Public Types

using funcptr_t = bool(*)(const std::int32_t, const std::int32_t)
 

Public Member Functions

 PortCoreMsgs_setProcessScheduling_helper ()=default
 
 PortCoreMsgs_setProcessScheduling_helper (const std::int32_t priority, const std::int32_t policy)
 
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 {"setProcessScheduling"}
 
static constexpr size_t s_tag_len {1}
 
static constexpr size_t s_cmd_len {3}
 
static constexpr size_t s_reply_len {1}
 
static constexpr const char * s_prototype {"bool PortCoreMsgs::setProcessScheduling(const std::int32_t priority, const std::int32_t policy)"}
 
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 1690 of file PortCoreMsgs.cpp.

Member Typedef Documentation

◆ funcptr_t

Definition at line 1739 of file PortCoreMsgs.cpp.

Constructor & Destructor Documentation

◆ PortCoreMsgs_setProcessScheduling_helper() [1/2]

yarp::os::PortCoreMsgs_setProcessScheduling_helper::PortCoreMsgs_setProcessScheduling_helper ( )
default

◆ PortCoreMsgs_setProcessScheduling_helper() [2/2]

yarp::os::PortCoreMsgs_setProcessScheduling_helper::PortCoreMsgs_setProcessScheduling_helper ( const std::int32_t  priority,
const std::int32_t  policy 
)

Definition at line 5390 of file PortCoreMsgs.cpp.

Member Function Documentation

◆ call()

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

Definition at line 5550 of file PortCoreMsgs.cpp.

◆ read()

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

◆ write()

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

Member Data Documentation

◆ cmd

Command yarp::os::PortCoreMsgs_setProcessScheduling_helper::cmd

Definition at line 1742 of file PortCoreMsgs.cpp.

◆ reply

Reply yarp::os::PortCoreMsgs_setProcessScheduling_helper::reply

Definition at line 1743 of file PortCoreMsgs.cpp.

◆ s_cmd_len

constexpr size_t yarp::os::PortCoreMsgs_setProcessScheduling_helper::s_cmd_len {3}
staticconstexpr

Definition at line 1747 of file PortCoreMsgs.cpp.

◆ s_help

constexpr const char* yarp::os::PortCoreMsgs_setProcessScheduling_helper::s_help
staticconstexpr
Initial value:
{
"Set the scheduling parameters of all the threads of the process which owns this port.\n"
"@param priority the scheduling priority (OS specific)\n"
"@param policy the scheduling policy (OS specific, e.g. on Linux 0 = SCHED_OTHER, 1 = SCHED_FIFO, 2 = SCHED_RR)\n"
"@return true if the scheduling parameters have been set"
}

Definition at line 1750 of file PortCoreMsgs.cpp.

◆ s_prototype

constexpr const char* yarp::os::PortCoreMsgs_setProcessScheduling_helper::s_prototype {"bool PortCoreMsgs::setProcessScheduling(const std::int32_t priority, const std::int32_t policy)"}
staticconstexpr

Definition at line 1749 of file PortCoreMsgs.cpp.

◆ s_reply_len

constexpr size_t yarp::os::PortCoreMsgs_setProcessScheduling_helper::s_reply_len {1}
staticconstexpr

Definition at line 1748 of file PortCoreMsgs.cpp.

◆ s_tag

constexpr const char* yarp::os::PortCoreMsgs_setProcessScheduling_helper::s_tag {"setProcessScheduling"}
staticconstexpr

Definition at line 1745 of file PortCoreMsgs.cpp.

◆ s_tag_len

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

Definition at line 1746 of file PortCoreMsgs.cpp.


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