BlockingQueue.hpp

Go to the documentation of this file.

// NIST-developed software is provided by NIST as a public service. You may use, copy and distribute copies of the software in any medium, provided that you keep intact this entire notice. You may improve, modify and create derivative works of the software or any portion of the software, and you may copy and distribute such modifications or works. Modified works should carry a notice stating that you changed the software and should note the date and nature of any such change. Please explicitly acknowledge the National Institute of Standards and Technology as the source of the software.
// NIST-developed software is expressly provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED, IN FACT OR ARISING BY OPERATION OF LAW, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT AND DATA ACCURACY. NIST NEITHER REPRESENTS NOR WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE CORRECTED. NIST DOES NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE SOFTWARE OR THE RESULTS THEREOF, INCLUDING BUT NOT LIMITED TO THE CORRECTNESS, ACCURACY, RELIABILITY, OR USEFULNESS OF THE SOFTWARE.
// You are solely responsible for determining the appropriateness of using and distributing the software and you assume all risks associated with its use, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and the unavailability or interruption of operation. This software is not intended to be used in any situation where a failure could cause risk of injury or damage to property. The software developed by NIST employees is not subject to copyright protection within the United States.

#ifndef HTGS_BLOCKINGQUEUE_HPP
#define HTGS_BLOCKINGQUEUE_HPP

#include <iostream>
#include <mutex>
#include <condition_variable>
#include <deque>
#include <queue>

namespace htgs {
template<class T>
class BlockingQueue {
 public:
  BlockingQueue() {
    this->queueSize = 0;
#ifdef PROFILE_QUEUE
    enqueueLockTime = 0;
    dequeueLockTime = 0;
    enqueueWaitTime = 0;
    dequeueWaitTime = 0;
#endif
#ifdef PROFILE

    queueActiveMaxSize = 0;
#endif
  }

  BlockingQueue(size_t qSize) {
    this->queueSize = qSize;
#ifdef PROFILE_QUEUE
    enqueueLockTime = 0;
    dequeueLockTime = 0;
    enqueueWaitTime = 0;
    dequeueWaitTime = 0;
#endif
#ifdef PROFILE
    queueActiveMaxSize = 0;
#endif
  }

  ~BlockingQueue() {
  }

  size_t remainingCapacity() {
    if (queueSize == 0) {
      std::cerr << __FILE__ << ":" << __LINE__
                << "ERROR: Requesting remaining capacity on BlockingQueue that does not have a max size" << std::endl;
    }
    return queueSize - queue.size();
  }

  bool isEmpty() {
    return queue.empty();
  }

  size_t size() {
    std::unique_lock<std::mutex> lock(this->mutex);
    return queue.size();
  }

  T remove() {
    T res = this->queue.front();
    this->queue.pop();
    return res;
  }

  void Enqueue(T const &value) {

#ifdef PROFILE_QUEUE
            auto start = std::chrono::high_resolution_clock::now();
#endif
    std::unique_lock<std::mutex> lock(this->mutex);
#ifdef PROFILE_QUEUE
    auto end = std::chrono::high_resolution_clock::now();
    this->enqueueLockTime += std::chrono::duration_cast<std::chrono::nanoseconds>(end - start).count();
#endif
    if (this->queueSize > 0) {
#ifdef PROFILE_QUEUE
        start = std::chrono::high_resolution_clock::now();
#endif
      this->condition.wait(lock, [=] { return this->queue.size() != queueSize; });
#ifdef PROFILE_QUEUE
        end = std::chrono::high_resolution_clock::now();
      this->enqueueWaitTime += std::chrono::duration_cast<std::chrono::nanoseconds>(end - start).count();
#endif
    }
    queue.push(value);

#ifdef PROFILE
    if (queue.size() > queueActiveMaxSize)
        queueActiveMaxSize = queue.size();
#endif

    this->condition.notify_one();
  }

  T Dequeue() {
#ifdef PROFILE_QUEUE
    auto start = std::chrono::high_resolution_clock::now();
#endif
    std::unique_lock<std::mutex> lock(this->mutex);
#ifdef PROFILE_QUEUE
    auto end = std::chrono::high_resolution_clock::now();
    this->dequeueLockTime += std::chrono::duration_cast<std::chrono::nanoseconds>(end - start).count();
    start = std::chrono::high_resolution_clock::now();
#endif
    this->condition.wait(lock, [=] { return !this->queue.empty(); });
#ifdef PROFILE_QUEUE
    end = std::chrono::high_resolution_clock::now();
    this->dequeueWaitTime += std::chrono::duration_cast<std::chrono::nanoseconds>(end - start).count();
#endif
    T res = this->queue.front();
    this->queue.pop();
    return res;
  }

  T poll(size_t timeout) {
    std::unique_lock<std::mutex> lock(this->mutex);
    if (this->condition.wait_for(lock, std::chrono::microseconds(timeout),
                                 [=] { return !this->queue.empty(); })) {
      T res = this->queue.front();
      this->queue.pop();
      return res;
    }
    return nullptr;
  }



#ifdef PROFILE_QUEUE
    unsigned long long int getEnqueueLockTime() const {
        return enqueueLockTime;
    }
    unsigned long long int getDequeueLockTime() const {
        return dequeueLockTime;
    }
    unsigned long long int getEnqueueWaitTime() const {
        return enqueueWaitTime;
    }
    unsigned long long int getDequeueWaitTime() const {
        return dequeueWaitTime;
    }
#endif

#ifdef PROFILE
  size_t getQueueActiveMaxSize() const {
    return queueActiveMaxSize;
  }

  void resetMaxQueueSize() {
    queueActiveMaxSize = 0;
  }
#endif

 private:
#ifdef PROFILE_QUEUE
    unsigned long long int enqueueLockTime; 
    unsigned long long int dequeueLockTime; 
    unsigned long long int enqueueWaitTime; 
    unsigned long long int dequeueWaitTime; 
#endif

#ifdef PROFILE
  size_t queueActiveMaxSize; 
#endif
  size_t queueSize; 
  std::queue<T> queue; 
  std::mutex mutex; 
  std::condition_variable condition; 
};
}

#endif //HTGS_BLOCKINGQUEUE_HPP