Hedgehog  0.0.0
A library to generate hybrid pipeline workflow systems
core_receiver.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_RECEIVER_H
21 #define HEDGEHOG_CORE_RECEIVER_H
22 
23 #include <queue>
24 #include <set>
25 #include <shared_mutex>
26 #include <algorithm>
27 
28 #include "../../../node/core_node.h"
29 #include "core_slot.h"
30 
32 namespace hh::core {
33 
34 #ifndef DOXYGEN_SHOULD_SKIP_THIS
35 template<class Input>
38 class CoreSender;
39 #endif //DOXYGEN_SHOULD_SKIP_THIS
40 
43 template<class Input>
44 class CoreReceiver : public virtual CoreNode {
45  public:
50  CoreReceiver(std::string_view const &name, NodeType const type, size_t const numberThreads)
51  : CoreNode(name, type, numberThreads) {
52  HLOG_SELF(0, "Creating CoreReceiver with type: " << (int) type << " and name: " << name)
53  }
54 
56  ~CoreReceiver() override {HLOG_SELF(0, "Destructing CoreReceiver")}
57 
60  virtual void addSender(CoreSender<Input> *sender) = 0;
61 
64  virtual void removeSender(CoreSender<Input> *sender) = 0;
65 
68  virtual void receive(std::shared_ptr<Input> data) = 0;
69 
72  virtual bool receiverEmpty() = 0;
73 
76  virtual size_t queueSize() { return 0; }
77 
80  virtual std::set<CoreReceiver<Input> *> receivers() = 0;
81 };
82 
83 }
84 #endif //HEDGEHOG_CORE_RECEIVER_H
NodeType type() const
Node type accessor.
Definition: core_node.h:132
virtual bool receiverEmpty()=0
Accessor to test emptiness on the receiver.
Receiver Interface, receive one data type from CoreSender.
Definition: core_receiver.h:44
~CoreReceiver() override
Default destructor.
Definition: core_receiver.h:56
virtual std::set< CoreReceiver< Input > * > receivers()=0
Accessor to all receivers connected to this receiver.
CoreReceiver(std::string_view const &name, NodeType const type, size_t const numberThreads)
Constructor with node name, node type and number of threads for the node.
Definition: core_receiver.h:50
virtual size_t queueSize()
Interface to get the number of element to be treated by this node for this type, by default return 0...
Definition: core_receiver.h:76
NodeType
Hedgehog node&#39;s type.
Definition: core_node.h:40
Sender interface, send data to CoreReceiver.
Definition: core_sender.h:35
Main Hedgehog core abstraction.
Definition: core_node.h:48
Hedgehog core namespace.
Definition: core_execute.h:25
std::string_view const & name() const
Node name accessor.
Definition: core_node.h:128
virtual void removeSender(CoreSender< Input > *sender)=0
Interface to remove a CoreSender from the receiver.
size_t numberThreads() const
Number of threads associated accessor.
Definition: core_node.h:152
virtual void receive(std::shared_ptr< Input > data)=0
Interface to receive a data.
virtual void addSender(CoreSender< Input > *sender)=0
Interface to add a CoreSender to the receiver.