Merge branch 'embb555_blocking_queue' into embb499_blocking_data_structures

containers_cpp/include/embb/containers/blocking_queue.h

+ /*
+ * Copyright (c) 2014-2015, Siemens AG. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef EMBB_CONTAINERS_BLOCKING_QUEUE_H_
+#define EMBB_CONTAINERS_BLOCKING_QUEUE_H_
+
+#include <queue>
+
+#include <embb/containers/blocking_container.h>
+
+namespace embb {
+namespace containers {
+
+/**
+* Wrapper for the standard library queue.
+*
+* \tparam T Element type
+*/
+template< typename Type>
+class BlockingQueue : public BlockingContainer<Type> {
+ private:
+  /**
+  * Internal queue from the standard library.
+  */
+  std::queue<Type> internalQueue;
+ public:
+  /**
+  * Enqueues an element in the internal queue.
+  */
+  void Enqueue(
+    const Type& element
+    /**< [IN] Constant reference to element to enqueue*/);
+
+  void Dequeue(
+    Type& element
+    /**< [IN] Reference to dequeued element*/);
+
+ protected:
+   /*
+   * Wrapper for the push method in the standard queue.
+   */
+  virtual void SpecializedPush(
+    const Type& element
+    /**< [IN] Constant reference to element to push.*/);
+
+  /**
+  * Wrapper for the pop method in the standard queue.
+  */
+  virtual void SpecializedPop(
+    Type& element
+    /**< [IN,OUT] Reference to element to the popped element*/);
+
+  /**
+  * Wrapper for the empty method in the standard queue.
+  */
+  virtual bool IsEmpty();
+
+};
+ 
+}  // namespace containers
+}  // namespace embb
+
+#include <embb/containers/internal/blocking_queue-inl.h>
+
+#endif  // EMBB_CONTAINERS_BLOCKING_QUEUE_H_
\ No newline at end of file

containers_cpp/include/embb/containers/internal/blocking_queue-inl.h

+#include "..\blocking_queue.h"
+/*
+ * Copyright (c) 2014-2015, Siemens AG. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef EMBB_CONTAINERS_INTERNAL_BLOCKING_QUEUE_INL_H_
+#define EMBB_CONTAINERS_INTERNAL_BLOCKING_QUEUE_INL_H_
+
+
+namespace embb {
+namespace containers {
+
+template <typename T>
+void BlockingQueue<T>::SpecializedPush(const T& element) {
+  internalQueue.push(element);
+}
+
+template <typename T>
+void BlockingQueue<T>::SpecializedPop(T& element) {
+  element = internalQueue.front();
+  internalQueue.pop();
+}
+
+template <typename T>
+bool BlockingQueue<T>::IsEmpty() {
+  return internalQueue.empty();
+}
+
+template <typename T>
+void BlockingQueue<T>::Enqueue(const T& element) {
+  PushAndWakeUp(element);
+}
+
+template <typename T>
+void BlockingQueue<T>::Dequeue(T& element) {
+  BlockingPop(element);
+}
+
+}  // namespace containers
+}  // namespace embb
+
+#endif  // EMBB_CONTAINERS_INTERNAL_BLOCKING_QUEUE_INL_H_

containers_cpp/test/blocking_queue_test-inl.h

+/*
+ * Copyright (c) 2014-2016, Siemens AG. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef CONTAINERS_CPP_TEST_BLOCKING_QUEUE_TEST_INL_H_
+#define CONTAINERS_CPP_TEST_BLOCKING_QUEUE_TEST_INL_H_
+
+#include <vector>
+#include <algorithm>
+
+namespace embb {
+namespace containers {
+namespace test {
+
+template <typename Container_t>
+void BlockingQueueTest<Container_t>::SpecializedPush(const int& element){
+  container.Enqueue(element);
+}
+
+template <typename Container_t>
+void BlockingQueueTest<Container_t>::SpecializedPop(int& element){
+  container.Dequeue(element);
+}
+
+} // namespace test
+} // namespace containers
+} // namespace embb
+
+#endif  // CONTAINERS_CPP_TEST_BLOCKING_QUEUE_TEST_INL_H_

containers_cpp/test/blocking_queue_test.h

+/*
+ * Copyright (c) 2014-2016, Siemens AG. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+#ifndef CONTAINERS_CPP_TEST_BLOCKING_QUEUE_TEST_H_
+#define CONTAINERS_CPP_TEST_BLOCKING_QUEUE_TEST_H_
+
+#include <vector>
+#include <partest/partest.h>
+#include <embb/base/duration.h>
+#include <./blocking_container_test.h>
+
+namespace embb {
+namespace containers {
+namespace test {
+template<typename Container_t>
+class BlockingQueueTest : public BlockingContainerTest<Container_t> {
+ protected:
+  virtual void SpecializedPush(const int& element);
+
+  virtual void SpecializedPop(int& element);
+};
+} // namespace test
+} // namespace containers
+} // namespace embb
+
+#include "./blocking_queue_test-inl.h"
+
+#endif  // CONTAINERS_CPP_TEST_BLOCKING_QUEUE_TEST_H_

containers_cpp/test/main.cc

@@ -30,6 +30,7 @@
 #include <embb/containers/object_pool.h>
 #include <embb/containers/lock_free_stack.h>
 #include <embb/containers/lock_free_mpmc_queue.h>
+#include <embb/containers/blocking_queue.h>
 #include <embb/base/c/memory_allocation.h>
 
 #include <partest/partest.h>
@@ -37,6 +38,7 @@
 
 #include "./pool_test.h"
 #include "./queue_test.h"
+#include "./blocking_queue_test.h"
 #include "./stack_test.h"
 #include "./hazard_pointer_test.h"
 #include "./object_pool_test.h"
@@ -47,12 +49,14 @@ using embb::containers::WaitFreeArrayValuePool;
 using embb::containers::LockFreeTreeValuePool;
 using embb::containers::WaitFreeSPSCQueue;
 using embb::containers::LockFreeMPMCQueue;
+using embb::containers::BlockingQueue;
 using embb::containers::LockFreeStack;
 using embb::containers::LockFreeTreeValuePool;
 using embb::containers::WaitFreeArrayValuePool;
 using embb::containers::test::PoolTest;
 using embb::containers::test::HazardPointerTest;
 using embb::containers::test::QueueTest;
+using embb::containers::test::BlockingQueueTest;
 using embb::containers::test::StackTest;
 using embb::containers::test::ObjectPoolTest;
 using embb::containers::test::HazardPointerTest2;
@@ -69,6 +73,7 @@ PT_MAIN("Data Structures C++") {
   PT_RUN(QueueTest< WaitFreeSPSCQueue< ::std::pair<size_t COMMA int> > >);
   PT_RUN(QueueTest< LockFreeMPMCQueue< ::std::pair<size_t COMMA int> >
     COMMA true COMMA true >);
+  PT_RUN(BlockingQueueTest< BlockingQueue<int> >);
   PT_RUN(StackTest< LockFreeStack<int> >);
   PT_RUN(ObjectPoolTest< LockFreeTreeValuePool<bool COMMA false > >);
   PT_RUN(ObjectPoolTest< WaitFreeArrayValuePool<bool COMMA false> >);