QPID 1306

- added QueueOptions helper
- added tests for Queue Options helper.




git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk/qpid@701397 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 113 insertions, 0 deletions

diff --git a/cpp/src/qpid/client/QueueOptions.h b/cpp/src/qpid/client/QueueOptions.h
new file mode 100644
index 0000000000..21333794ac
--- /dev/null
+++ b/cpp/src/qpid/client/QueueOptions.h
@@ -0,0 +1,113 @@
+/*
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ * 
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ */
+#include "qpid/framing/FieldTable.h"
+
+#ifndef _QueueOptions_
+#define _QueueOptions_
+
+namespace qpid {
+namespace client {
+
+enum QueueSizePolicy {NONE, REJECT, FLOW_TO_DISK, RING, RING_STRICT};
+enum QueueOrderingPolicy {FIFO, LVQ};	
+
+/**
+ * A help class to set options on the Queue. Create a configured args while
+ * still allowing any custom configuration via the FieldTable base class
+ */
+class QueueOptions: public framing::FieldTable
+{
+  public:
+    QueueOptions();
+    virtual ~QueueOptions();
+	
+	/**
+	* Sets the queue sizing plocy
+	* 
+	* @param 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
+	* @param maxSize Set the max number of bytes for the sizing policies
+	* @param setMaxCount Set the max number of messages for the sizing policies
+	*/
+	void setSizePolicy(QueueSizePolicy sp, uint64_t maxSize, uint32_t maxCount );
+
+	/**
+	* Enables optimistic consume allowing the consumer to dequeue the message before the
+	* broker has safe stored it.
+	*/
+	void setOptimisticConsume();
+	
+	/**
+	* 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.
+	*/
+	void setPersistLastNode();
+	
+	/**
+	* Sets the odering policy on the Queue, default ordering is FIFO.
+	*/
+	void setOrdering(QueueOrderingPolicy op);
+    
+	/**
+	* Use broker defualt sizing ploicy
+	*/
+	void clearSizePolicy();
+	
+	/**
+	* Clear Optimistic Consume Policy
+	*/ 
+	void clearOptimisticConsume();
+	
+	/**
+	* Clear Persist Last Node Policy
+	*/ 
+	void clearPersistLastNode();
+	
+	/**
+	* Use default odering policy
+	*/ 
+	void clearOrdering();
+	
+	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;
+	private:
+	
+
+
+};
+
+}
+}
+
+
+#endif