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
MessageStack &	operator= (const MessageStack &)=delete
MessageStack &	operator= (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 22 of file MessageStack.h.

Constructor & Destructor Documentation

MessageStack() [1/3]

MessageStack::MessageStack ( size_t  max_threads = 0 )

explicit

Constructor.

Parameters

max_threads

maximum number of worker threads allowed (0 means unlimited)

Definition at line 183 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 188 of file MessageStack.cpp.

Member Function Documentation

attach()

void MessageStack::attach

(

PortReader &

owner

)

Parameters

owner

the destination to send messages to

Definition at line 193 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

msg	the message to send
tag	an optional string to prefix the message with

Definition at line 198 of file MessageStack.cpp.

---

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

• src/libYARP_os/src/yarp/os/MessageStack.h
• src/libYARP_os/src/yarp/os/MessageStack.cpp