artdaq  v3_10_01
RequestReceiver.hh
1 #ifndef ARTDAQ_DAQRATE_REQUEST_RECEVIER_HH
2 #define ARTDAQ_DAQRATE_REQUEST_RECEVIER_HH
3 
4 #include <boost/thread.hpp>
5 #include <mutex>
6 
7 #include "fhiclcpp/ParameterSet.h"
8 #include "fhiclcpp/types/Atom.h"
9 #include "fhiclcpp/types/ConfigurationTable.h"
10 
11 #include "artdaq-core/Data/Fragment.hh"
12 #include "artdaq/DAQrate/RequestBuffer.hh"
13 
14 namespace artdaq {
19 {
20 public:
24  struct Config
25  {
27  fhicl::Atom<bool> receive_requests{fhicl::Name{"receive_requests"}, fhicl::Comment{"Whether this RequestReceiver will listen for requests"}, false};
29  fhicl::Atom<int> request_port{fhicl::Name{"request_port"}, fhicl::Comment{"Port to listen for request messages on"}, 3001};
31  fhicl::Atom<std::string> request_addr{fhicl::Name{"request_address"}, fhicl::Comment{"Multicast address to listen for request messages on"}, "227.128.12.26"};
33  fhicl::Atom<std::string> output_address{fhicl::Name{"multicast_interface_ip"}, fhicl::Comment{"Use this hostname for multicast (to assign to the proper NIC)"}, "0.0.0.0"};
35  fhicl::Atom<size_t> end_of_run_timeout_ms{fhicl::Name{"end_of_run_quiet_timeout_ms"}, fhicl::Comment{"Amount of time (in ms) to wait for no new requests when a Stop transition is pending"}, 1000};
36  };
38  using Parameters = fhicl::WrappedTable<Config>;
39 
44 
50  RequestReceiver(const fhicl::ParameterSet& ps, std::shared_ptr<RequestBuffer> output_buffer);
51 
55  virtual ~RequestReceiver();
56 
60  void setupRequestListener();
61 
66  void stopRequestReception(bool force = false);
67 
71  void startRequestReception();
72 
76  void receiveRequestsLoop();
77 
82  bool isRunning() { return running_; }
83 
88  void SetRunNumber(uint32_t run) { run_number_ = run; }
89 
90 private:
91  RequestReceiver(RequestReceiver const&) = delete;
92  RequestReceiver(RequestReceiver&&) = delete;
93  RequestReceiver& operator=(RequestReceiver const&) = delete;
94  RequestReceiver& operator=(RequestReceiver&&) = delete;
95 
96  bool running_{false};
97  std::atomic<bool> request_stop_requested_;
98  std::atomic<bool> request_received_;
99  std::atomic<bool> should_stop_;
100 
101  int request_port_{3001};
102  uint32_t run_number_{0};
103  std::string request_addr_;
104  std::string multicast_in_addr_;
105  bool receive_requests_;
106 
107  //Socket parameters
108  int request_socket_{-1};
109  std::chrono::steady_clock::time_point request_stop_timeout_;
110  size_t end_of_run_timeout_ms_{1000};
111  mutable std::mutex state_mutex_;
112  boost::thread requestThread_;
113 
114  std::shared_ptr<RequestBuffer> requests_;
115 };
116 } // namespace artdaq
117 
118 #endif //ARTDAQ_DAQRATE_REQUEST_RECEVIER_HH
void startRequestReception()
Enables (starts) the reception of data requests.
fhicl::Atom< size_t > end_of_run_timeout_ms
&quot;end_of_run_quiet_timeout_ms&quot; (Default: 1000) : Time, in milliseconds, that the entire system must be...
fhicl::Atom< std::string > request_addr
&quot;request_address&quot; (Default: &quot;227.128.12.26&quot;) : Address which CommandableFragmentGenerator will listen...
fhicl::Atom< std::string > output_address
&quot;multicast_interface_ip&quot; (Default: &quot;0.0.0.0&quot;) : Use this hostname for multicast(to assign to the prop...
fhicl::WrappedTable< Config > Parameters
Used for ParameterSet validation (if desired)
RequestReceiver()
RequestReceiver Default Constructor.
bool isRunning()
Determine if the RequestReceiver is receiving requests
void setupRequestListener()
Opens the socket used to listen for data requests.
void receiveRequestsLoop()
This function receives data request packets, adding new requests to the request list.
virtual ~RequestReceiver()
RequestReceiver Destructor.
Receive data requests and make them available to CommandableFragmentGenerator or other interested par...
void SetRunNumber(uint32_t run)
Sets the current run number
fhicl::Atom< int > request_port
&quot;request_port&quot; (Default: 3001) : Port on which data requests will be received
void stopRequestReception(bool force=false)
Disables (stops) the reception of data requests.
fhicl::Atom< bool > receive_requests
&quot;receive_requests&quot; (Default: false): Whether this RequestReceiver will listen for requests ...
Configuration of the RequestReceiver. May be used for parameter validation