Hedgehog  0.0.0
A library to generate hybrid pipeline workflow systems
core_multi_receivers.h
1 // NIST-developed software is provided by NIST as a public service. You may use, copy and distribute copies of the
2 // software in any medium, provided that you keep intact this entire notice. You may improve, modify and create
3 // derivative works of the software or any portion of the software, and you may copy and distribute such modifications
4 // or works. Modified works should carry a notice stating that you changed the software and should note the date and
5 // nature of any such change. Please explicitly acknowledge the National Institute of Standards and Technology as the
6 // source of the software. NIST-developed software is expressly provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND,
7 // EXPRESS, IMPLIED, IN FACT OR ARISING BY OPERATION OF LAW, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
8 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT AND DATA ACCURACY. NIST NEITHER REPRESENTS NOR
9 // WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE
10 // CORRECTED. NIST DOES NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE SOFTWARE OR THE RESULTS
11 // THEREOF, INCLUDING BUT NOT LIMITED TO THE CORRECTNESS, ACCURACY, RELIABILITY, OR USEFULNESS OF THE SOFTWARE. You
12 // are solely responsible for determining the appropriateness of using and distributing the software and you assume
13 // all risks associated with its use, including but not limited to the risks and costs of program errors, compliance
14 // with applicable laws, damage to or loss of data, programs or equipment, and the unavailability or interruption of
15 // operation. This software is not intended to be used in any situation where a failure could cause risk of injury or
16 // damage to property. The software developed by NIST employees is not subject to copyright protection within the
17 // United States.
18 
19 
20 #ifndef HEDGEHOG_CORE_MULTI_RECEIVERS_H
21 #define HEDGEHOG_CORE_MULTI_RECEIVERS_H
22 
23 #include "core_receiver.h"
24 #include "core_slot.h"
25 #include "../../../node/core_node.h"
26 
28 namespace hh::core {
29 
30 #ifndef DOXYGEN_SHOULD_SKIP_THIS
31 template<class Input>
34 class CoreQueueSender;
35 #endif //DOXYGEN_SHOULD_SKIP_THIS
36 
39 template<class ...Inputs>
40 class CoreMultiReceivers : public virtual CoreSlot, public virtual CoreReceiver<Inputs> ... {
41  public:
46  CoreMultiReceivers(std::string_view const &name, NodeType const type, size_t const numberThreads) :
47  CoreSlot(name, type, numberThreads), CoreReceiver<Inputs>(name, type, numberThreads)... {
48  HLOG_SELF(0, "Creating CoreMultiReceivers with type: " << (int) type << " and name: " << name)
49  }
50 
52  ~CoreMultiReceivers() override {HLOG_SELF(0, "Destructing CoreMultiReceivers")}
53 
56  virtual bool receiversEmpty() = 0;
57 
60  virtual size_t totalQueueSize() { return 0; }
61 
64  void removeForAllSenders(CoreNode *coreNode) {
65  (this->removeForAllSendersConditional<Inputs>(coreNode), ...);
66  }
67 
68  private:
72  template<class Input>
74  // If coreNode *is* a CoreQueueSender for a specific Input type
75  if (auto temp = dynamic_cast<CoreQueueSender<Input> *>(coreNode)) {
76  // Remove the sender for this multi receiver
77  static_cast<CoreReceiver<Input> *>(this)->removeSender(temp);
78  }
79  }
80 
81 };
82 
83 }
84 #endif //HEDGEHOG_CORE_MULTI_RECEIVERS_H
NodeType type() const
Node type accessor.
Definition: core_node.h:132
Receiver Interface, receive one data type from CoreSender.
Definition: core_receiver.h:44
void removeForAllSenders(CoreNode *coreNode)
Remove all coreNode&#39;s senders from this.
virtual size_t totalQueueSize()
Compute all receivers queue size.
Multi receiver interface, gather multiple CoreReceiver.
Sender for nodes possessing a queue of data.
~CoreMultiReceivers() override
CoreMultiReceivers destructor.
Slot interface, receive notification from CoreNotifier.
Definition: core_slot.h:34
NodeType
Hedgehog node&#39;s type.
Definition: core_node.h:40
Main Hedgehog core abstraction.
Definition: core_node.h:48
Hedgehog core namespace.
Definition: core_execute.h:25
void removeForAllSendersConditional(CoreNode *coreNode)
Remove all coreNode&#39;s senders from this for a specific Input type.
std::string_view const & name() const
Node name accessor.
Definition: core_node.h:128
virtual bool receiversEmpty()=0
Test if all receivers are empty.
virtual void removeSender(CoreSender< Inputs > *sender)=0
Interface to remove a CoreSender from the receiver.
size_t numberThreads() const
Number of threads associated accessor.
Definition: core_node.h:152
CoreMultiReceivers(std::string_view const &name, NodeType const type, size_t const numberThreads)
CoreMultiReceivers constructor.