AnyConnector.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_ANYCONNECTOR_HPP
#define HTGS_ANYCONNECTOR_HPP

#include <atomic>
#include <sstream>

#include <htgs/api/IData.hpp>
#include <htgs/types/TaskGraphDotGenFlags.hpp>

namespace htgs {

class AnyConnector {
 public:

  AnyConnector() : producerTaskCount(0) {}

  virtual ~AnyConnector() {}

#ifdef PROFILE_QUEUE

  virtual std::string getQueueTiming() = 0;
#endif

  void producerFinished() {
    this->producerTaskCount--;
  }

  size_t getProducerCount() {
    return this->producerTaskCount;
  }

  void incrementInputTaskCount() { this->producerTaskCount++; }

  std::string getDotId() {
    std::ostringstream inConn;
    inConn << "x" << this;
    std::string inConnStr = inConn.str();

    return inConnStr;
  }

  std::string genDot(int flags) {
    return getDotId() + "[label=\""
        + ((flags & DOTGEN_FLAG_SHOW_CONNECTOR_VERBOSE) == 0 ? std::to_string(this->getProducerCount()) : "Active Producers: " + std::to_string(this->getProducerCount()))
        + ((flags & DOTGEN_FLAG_SHOW_CURRENT_Q_SZ) == 0 && (flags & DOTGEN_FLAG_SHOW_CONNECTOR_VERBOSE) == 0 ? "" : "\\n Queue Size: " + std::to_string(this->getQueueSize()))
#ifdef PROFILE_QUEUE
        + ", enqLock, deqLock, enqWait, deqWait::" + getQueueTiming()
#endif
        + "\",shape=box,style=rounded,color=black,width=.2,height=.2];\n";

  }

  virtual std::string typeName() = 0;

  virtual bool isInputTerminated() = 0;

  virtual void wakeupConsumer() = 0;

  virtual AnyConnector *copy() = 0;

  virtual void produceAnyData(std::shared_ptr<IData> data) = 0;

  virtual void profileProduce(size_t numThreads) = 0;

  virtual void profileConsume(size_t numThreads, bool showQueueSize) = 0;

  virtual size_t getMaxQueueSize() = 0;

  virtual size_t getQueueSize() = 0;

  virtual void resetMaxQueueSize() = 0;

 private:
  std::atomic_size_t producerTaskCount; 

};
}

#endif //HTGS_ANYCONNECTOR_HPP