Collage  0.6.1
Public Member Functions
co::QueueMaster Class Reference

The producer end of a distributed queue. More...

#include <queueMaster.h>

+ Inheritance diagram for co::QueueMaster:
+ Collaboration diagram for co::QueueMaster:

List of all members.

Public Member Functions

CO_API QueueMaster ()
 Construct a new queue master.
virtual CO_API ~QueueMaster ()
 Destruct this queue master.
CO_API void push (const QueueItemPacket &packet)
 Enqueue a new item.
CO_API void clear ()
 Remove all enqueued items.

Detailed Description

The producer end of a distributed queue.

One instance of this class is registered with a LocalNode to for the producer end of a distributed queue. One or more QueueSlave instances are mapped to this master instance and consume the data.

Definition at line 36 of file queueMaster.h.


Constructor & Destructor Documentation

Construct a new queue master.

Version:
1.1.6
virtual CO_API co::QueueMaster::~QueueMaster ( ) [virtual]

Destruct this queue master.

Version:
1.1.6

Member Function Documentation

CO_API void co::QueueMaster::clear ( )

Remove all enqueued items.

Version:
1.1.6
CO_API void co::QueueMaster::push ( const QueueItemPacket packet)

Enqueue a new item.

The enqueued item has to inherit from QueueItemPacket and be a flat structure, that is, it should only contain POD data and no pointers. The packet is copied as is over the network, using the packet's size parameter. The packet is copied by this method.

Parameters:
packetthe item to enqueue.
Version:
1.1.6

The documentation for this class was generated from the following file:
Generated on Mon Nov 26 2012 14:41:44 for Collage 0.6.1 by  doxygen 1.7.6.1