artdaq  v3_06_00
RequestReceiver.hh
1 #ifndef ARTDAQ_DAQRATE_REQUEST_RECEVIER_HH
2 #define ARTDAQ_DAQRATE_REQUEST_RECEVIER_HH
3 
4 #include <boost/thread.hpp>
5 #include "artdaq-core/Data/Fragment.hh"
6 #include "fhiclcpp/ParameterSet.h"
7 #include "fhiclcpp/types/Atom.h"
8 #include "fhiclcpp/types/ConfigurationTable.h"
9 
10 #include <mutex>
11 #include <condition_variable>
12 
13 namespace artdaq
14 {
19  {
20  public:
21 
25  struct Config
26  {
28  fhicl::Atom<int> request_port{ fhicl::Name{"request_port"}, fhicl::Comment{"Port to listen for request messages on"}, 3001 };
30  fhicl::Atom<std::string> request_addr{ fhicl::Name{"request_address"}, fhicl::Comment{"Multicast address to listen for request messages on"}, "227.128.12.26" };
32  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" };
34  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  fhicl::Atom<artdaq::Fragment::sequence_id_t> request_increment{ fhicl::Name{"request_increment"}, fhicl::Comment{"Expected increment of sequence ID between each request"}, 1 };
37  };
39  using Parameters = fhicl::WrappedTable<Config>;
40 
45 
50  RequestReceiver(const fhicl::ParameterSet& ps);
51  virtual ~RequestReceiver();
52 
56  void setupRequestListener();
57 
62  void stopRequestReception(bool force = false);
63 
67  void startRequestReception();
68 
72  void receiveRequestsLoop();
73 
78  std::map<artdaq::Fragment::sequence_id_t, artdaq::Fragment::timestamp_t> GetRequests() const
79  {
80  std::unique_lock<std::mutex> lk(request_mutex_);
81  std::map<artdaq::Fragment::sequence_id_t, Fragment::timestamp_t> out;
82  for (auto& in : requests_)
83  {
84  out[in.first] = in.second;
85  }
86  return out;
87  }
88 
93  void RemoveRequest(artdaq::Fragment::sequence_id_t reqID);
94 
99  bool isRunning() { return running_; }
100 
105  {
106  std::unique_lock<std::mutex> lk(request_mutex_);
107  requests_.clear();
108  }
109 
114  std::map<artdaq::Fragment::sequence_id_t, artdaq::Fragment::timestamp_t> GetAndClearRequests()
115  {
116  std::unique_lock<std::mutex> lk(request_mutex_);
117  std::map<artdaq::Fragment::sequence_id_t, Fragment::timestamp_t> out;
118  for (auto& in : requests_)
119  {
120  out[in.first] = in.second;
121  }
122  if(requests_.size()) {highest_seen_request_ = requests_.rbegin()->first;}
123  out_of_order_requests_.clear();
124  requests_.clear();
125  request_timing_.clear();
126  return out;
127  }
128 
133  size_t size() {
134  std::unique_lock<std::mutex> tlk(request_mutex_);
135  return requests_.size();
136  }
137 
143  bool WaitForRequests(int timeout_ms)
144  {
145  std::unique_lock<std::mutex> lk(request_mutex_); // Lock needed by wait_for
146  // See if we have to wait at all
147  if (requests_.size() > 0) return true;
148  // If we do have to wait, check requests_.size to make sure we're not being notified spuriously
149  return request_cv_.wait_for(lk, std::chrono::milliseconds(timeout_ms), [this]() { return requests_.size() > 0; });
150  }
151 
157  std::chrono::steady_clock::time_point GetRequestTime(artdaq::Fragment::sequence_id_t reqID)
158  {
159  std::unique_lock<std::mutex> lk(request_mutex_);
160  return request_timing_.count(reqID) ? request_timing_[reqID] : std::chrono::steady_clock::now();
161  }
162 
167  void SetRunNumber(uint32_t run) {run_number_ = run;}
168  private:
169  // FHiCL-configurable variables. Note that the C++ variable names
170  // are the FHiCL variable names with a "_" appended
171  int request_port_;
172  std::string request_addr_;
173  std::string multicast_in_addr_;
174  bool running_;
175  uint32_t run_number_;
176 
177  //Socket parameters
178  int request_socket_;
179  std::map<artdaq::Fragment::sequence_id_t, artdaq::Fragment::timestamp_t> requests_;
180  std::map<artdaq::Fragment::sequence_id_t, std::chrono::steady_clock::time_point> request_timing_;
181  std::atomic<bool> request_stop_requested_;
182  std::chrono::steady_clock::time_point request_stop_timeout_;
183  std::atomic<bool> request_received_;
184  size_t end_of_run_timeout_ms_;
185  std::atomic<bool> should_stop_;
186  mutable std::mutex request_mutex_;
187  mutable std::mutex state_mutex_;
188  std::condition_variable request_cv_;
189  boost::thread requestThread_;
190 
191  std::atomic<artdaq::Fragment::sequence_id_t> highest_seen_request_;
192  std::set<artdaq::Fragment::sequence_id_t> out_of_order_requests_;
193  artdaq::Fragment::sequence_id_t request_increment_;
194  };
195 }
196 
197 
198 #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...
std::chrono::steady_clock::time_point GetRequestTime(artdaq::Fragment::sequence_id_t reqID)
Get the time a given request was received
size_t size()
Get the number of requests currently stored in the RequestReceiver
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.
Receive data requests and make them available to CommandableFragmentGenerator or other interested par...
std::map< artdaq::Fragment::sequence_id_t, artdaq::Fragment::timestamp_t > GetAndClearRequests()
Get the current requests, then clear the map
void ClearRequests()
Clear all requests from the map
void SetRunNumber(uint32_t run)
Sets the current run number
bool WaitForRequests(int timeout_ms)
Wait for a new request message, up to the timeout given
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.
void RemoveRequest(artdaq::Fragment::sequence_id_t reqID)
Remove the request with the given sequence ID from the request map
fhicl::Atom< artdaq::Fragment::sequence_id_t > request_increment
&quot;request_increment&quot; (Default: 1) : Expected increment of sequence ID between each request ...
std::map< artdaq::Fragment::sequence_id_t, artdaq::Fragment::timestamp_t > GetRequests() const
Get the current requests
Configuration of the RequestReceiver. May be used for parameter validation