AceSmartSoft API Documentation
Public Member Functions | List of all members
SmartACE::MessageQueue< Item > Class Template Reference

unbounded message queue for communication between threads. More...

#include <smartMessageQueue.hh>

Public Member Functions

 MessageQueue ()
 constructor. More...
 
virtual ~MessageQueue ()
 destructor More...
 
void enqueue (const Item &item)
 enqueue an item. More...
 
Item dequeue ()
 dequeue an item. More...
 

Detailed Description

template<class Item>
class SmartACE::MessageQueue< Item >

unbounded message queue for communication between threads.

This queue can be used to connect two threads together, for example to enqueue commands and queries that can't be executed inside a SendHandler, or QueryHandler.

Queue items are processed in FIFO order.

Constructor & Destructor Documentation

◆ MessageQueue()

template<class Item >
SmartACE::MessageQueue< Item >::MessageQueue ( )

constructor.

◆ ~MessageQueue()

template<class Item >
virtual SmartACE::MessageQueue< Item >::~MessageQueue ( )
virtual

destructor

Member Function Documentation

◆ dequeue()

template<class Item >
Item SmartACE::MessageQueue< Item >::dequeue ( )

dequeue an item.

dequeues the head item. if no item is available, blocks till one arrives.

Returns
copy of the enqueued item.

◆ enqueue()

template<class Item >
void SmartACE::MessageQueue< Item >::enqueue ( const Item &  item)

enqueue an item.

Parameters
itemto enqueue. A copy of the item is stored in the queue

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