YARP
Yet Another Robot Platform
yarp::os::MessageStack Class Reference

Maintain a stack of messages to send asynchronously. More...

#include <yarp/os/MessageStack.h>

Classes

class  Private
 

Public Member Functions

 MessageStack (size_t max_threads=0)
 Constructor. More...
 
 MessageStack (const MessageStack &)=delete
 
 MessageStack (MessageStack &&) noexcept=delete
 
MessageStackoperator= (const MessageStack &)=delete
 
MessageStackoperator= (MessageStack &&)=delete
 
virtual ~MessageStack ()
 Destructor. More...
 
void attach (PortReader &owner)
 
void stack (PortWriter &msg, const std::string &tag="")
 Add a message to the message stack, to be sent whenever the gods see fit. More...
 

Detailed Description

Maintain a stack of messages to send asynchronously.

Definition at line 19 of file MessageStack.h.

Constructor & Destructor Documentation

◆ MessageStack() [1/3]

MessageStack::MessageStack ( size_t  max_threads = 0)
explicit

Constructor.

Parameters
max_threadsmaximum number of worker threads allowed (0 means unlimited)

Definition at line 180 of file MessageStack.cpp.

◆ MessageStack() [2/3]

yarp::os::MessageStack::MessageStack ( const MessageStack )
delete

◆ MessageStack() [3/3]

yarp::os::MessageStack::MessageStack ( MessageStack &&  )
deletenoexcept

◆ ~MessageStack()

MessageStack::~MessageStack ( )
virtual

Destructor.

Definition at line 185 of file MessageStack.cpp.

Member Function Documentation

◆ attach()

void MessageStack::attach ( PortReader owner)
Parameters
ownerthe destination to send messages to

Definition at line 190 of file MessageStack.cpp.

◆ operator=() [1/2]

MessageStack& yarp::os::MessageStack::operator= ( const MessageStack )
delete

◆ operator=() [2/2]

MessageStack& yarp::os::MessageStack::operator= ( MessageStack &&  )
delete

◆ stack()

void MessageStack::stack ( PortWriter msg,
const std::string &  tag = "" 
)

Add a message to the message stack, to be sent whenever the gods see fit.

Parameters
msgthe message to send
tagan optional string to prefix the message with

Definition at line 195 of file MessageStack.cpp.


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