qpid::client::QueueOptions Class Reference

A help class to set options on the Queue. More...

#include <QueueOptions.h>

Inheritance diagram for qpid::client::QueueOptions:

Inheritance graph
[legend]
Collaboration diagram for qpid::client::QueueOptions:

Collaboration graph
[legend]

List of all members.

Public Member Functions

void setSizePolicy (QueueSizePolicy sp, uint64_t maxSize, uint32_t maxCount)
 Sets the queue sizing plocy.
void setOptimisticConsume ()
 Enables optimistic consume allowing the consumer to dequeue the message before the broker has safe stored it.
void setPersistLastNode ()
 Enables the persisting of a queue to the store module when a cluster fails down to it's last node.
void setOrdering (QueueOrderingPolicy op)
 Sets the odering policy on the Queue, default ordering is FIFO.
void clearSizePolicy ()
 Use broker defualt sizing ploicy.
void clearOptimisticConsume ()
 Clear Optimistic Consume Policy.
void clearPersistLastNode ()
 Clear Persist Last Node Policy.
void getLVQKey (std::string &key)
 get the key used match LVQ in args for message transfer
void clearOrdering ()
 Use default odering policy.

Static Public Attributes

static const std::string strMaxCountKey
static const std::string strMaxSizeKey
static const std::string strTypeKey
static const std::string strREJECT
static const std::string strFLOW_TO_DISK
static const std::string strRING
static const std::string strRING_STRICT
static const std::string strLastValueQueue
static const std::string strOptimisticConsume
static const std::string strPersistLastNode
static const std::string strLVQMatchProperty


Detailed Description

A help class to set options on the Queue.

Create a configured args while still allowing any custom configuration via the FieldTable base class

Definition at line 36 of file QueueOptions.h.


Member Function Documentation

void qpid::client::QueueOptions::setSizePolicy ( QueueSizePolicy  sp,
uint64_t  maxSize,
uint32_t  maxCount 
)

Sets the queue sizing plocy.

Parameters:
sp SizePolicy REJECT - reject if queue greater than size/count FLOW_TO_DISK - page messages to disk from this point is greater than size/count RING - limit the queue to size/count and over-write old messages round a ring RING_STRICT - limit the queue to size/count and reject is head == tail NONE - Use default broker sizing policy
maxSize Set the max number of bytes for the sizing policies
setMaxCount Set the max number of messages for the sizing policies

void qpid::client::QueueOptions::setPersistLastNode (  ) 

Enables the persisting of a queue to the store module when a cluster fails down to it's last node.

Does so optimistically. Will start persisting when cluster count >1 again.


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

Generated on Thu Oct 16 13:38:20 2008 for Qpid by  doxygen 1.5.6