Connector.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_CONNECTOR_HPP
#define HTGS_CONNECTOR_HPP

#include <atomic>

#include <list>

#if defined( __GLIBCXX__ ) || defined( __GLIBCPP__ )
#include <cxxabi.h>
#endif

#include <htgs/debug/debug_message.hpp>
#include <htgs/api/IData.hpp>

#ifdef USE_PRIORITY_QUEUE
#include <htgs/core/queue/PriorityBlockingQueue.hpp>
#else
#include <htgs/core/queue/BlockingQueue.hpp>
#endif

#include <htgs/core/graph/AnyConnector.hpp>

namespace htgs {

template<class T>
class Connector : public AnyConnector {
  static_assert(std::is_base_of<IData, T>::value, "T must derive from IData");

 public:
  Connector() {}

  ~Connector() {}

  bool isInputTerminated() override { return super::getProducerCount() == 0 && this->queue.isEmpty(); }

  Connector<T> *copy() override { return new Connector<T>(); }

  void wakeupConsumer() override { this->queue.Enqueue(nullptr); }

  void profileProduce(size_t numThreads) override {}

  void profileConsume(size_t numThreads, bool showQueueSize) override {
#ifdef PROFILE
    std::cout << "consume largest queue size: " << queue.getQueueActiveMaxSize() << std::endl;
#endif
  }

  size_t getQueueSize() override {
    return this->queue.size();
  }

  size_t getMaxQueueSize() override {
#ifdef PROFILE
    return queue.getQueueActiveMaxSize();
#else
    return 0;
#endif
  }

  void resetMaxQueueSize() override {
#ifdef PROFILE
    this->queue.resetMaxQueueSize();
#endif
  }

  void produceAnyData(std::shared_ptr<IData> data) override {
    HTGS_DEBUG_VERBOSE("Connector " << this << " producing any data: " << data);
    std::shared_ptr<T> dataCast = std::dynamic_pointer_cast<T>(data);
    this->queue.Enqueue(dataCast);

  }

  std::shared_ptr<T> pollConsumeData(size_t timeout) {
    std::shared_ptr<T> data = this->queue.poll(timeout);
    return data;
  }

  std::shared_ptr<T> consumeData() {
    std::shared_ptr<T> data = this->queue.Dequeue();
    return data;
  }

  void produceData(std::shared_ptr<T> data) {
    HTGS_DEBUG_VERBOSE("Connector " << this << " producing data: " << data);
    this->queue.Enqueue(data);
  }

  void produceData(std::list<std::shared_ptr<T>> *data) {
    for (std::shared_ptr<T> v : *data) {
      HTGS_DEBUG_VERBOSE("Connector " << this << " producing list data: " << v);

      this->queue.Enqueue(v);
    }
  }

#ifdef PROFILE_QUEUE
  std::string getQueueTiming() override {
    return std::to_string(queue.getEnqueueLockTime()) + ", "
      + std::to_string(queue.getDequeueLockTime()) + ", "
      + std::to_string(queue.getEnqueueWaitTime()) + ", "
      + std::to_string(queue.getDequeueWaitTime());
  }
#endif

  std::string typeName() override {
#if defined( __GLIBCXX__ ) || defined( __GLIBCPP__ )
    int status;
    char *realName = abi::__cxa_demangle(typeid(T).name(), 0, 0, &status);
    std::string ret(realName);

    free(realName);

    return ret;
#else
    return typeid(T).name();
#endif

  }

 private:
  typedef AnyConnector super;

#ifdef USE_PRIORITY_QUEUE
  PriorityBlockingQueue<std::shared_ptr<T>>
#else
  BlockingQueue <std::shared_ptr<T>>
#endif
      queue; 
};
}

#endif //HTGS_CONNECTOR_HPP