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

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

#include <yarp/os/MessageStack.h>

Detailed Description

Maintain a stack of messages to send asynchronously.

Definition at line 26 of file MessageStack.h.

Public Member Functions

 MessageStack (int max_threads=0)
 Constructor. More...
 
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...
 

Private Attributes

int max_threads
 
void * implementation
 

Constructor & Destructor Documentation

◆ MessageStack()

MessageStack::MessageStack ( int  max_threads = 0)

Constructor.

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

Definition at line 121 of file MessageStack.cpp.

◆ ~MessageStack()

MessageStack::~MessageStack ( )
virtual

Destructor.

Definition at line 126 of file MessageStack.cpp.

Member Function Documentation

◆ attach()

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

Definition at line 133 of file MessageStack.cpp.

◆ 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 143 of file MessageStack.cpp.

Member Data Documentation

◆ implementation

void* yarp::os::MessageStack::implementation
private

Definition at line 62 of file MessageStack.h.

◆ max_threads

int yarp::os::MessageStack::max_threads
private

Definition at line 61 of file MessageStack.h.


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