artdaq  v3_09_00
CommanderInterface.hh
1 #ifndef artdaq_ExternalComms_CommanderInterface_hh
2 #define artdaq_ExternalComms_CommanderInterface_hh
3 
4 #include "artdaq/Application/Commandable.hh"
5 #include "artdaq/DAQdata/Globals.hh"
6 #include "cetlib/compiler_macros.h"
7 #include "fhiclcpp/ParameterSet.h"
8 
9 namespace artdaq {
14 {
15 public:
19  struct Config
20  {
22  fhicl::Atom<int> id{fhicl::Name{"id"}, fhicl::Comment{"The unique ID associated with this Commander plugin. (ex. XMLRPC Port number)"}, 0};
24  fhicl::Atom<std::string> commanderPluginType{fhicl::Name{"commanderPluginType"}, fhicl::Comment{"String identifying the name of the CommanderInterface plugin to load"}};
25  };
27  using Parameters = fhicl::WrappedTable<Config>;
28 
34  CommanderInterface(const fhicl::ParameterSet& ps, artdaq::Commandable& commandable)
35  : _commandable(commandable)
36  , _id(ps.get<int>("id", 0))
37  {}
38 
42  CommanderInterface(const CommanderInterface&) = delete;
43 
49 
53  virtual ~CommanderInterface();
54 
83  virtual void run_server() = 0;
84 
95  virtual std::string send_init(fhicl::ParameterSet const& ps, uint64_t timeout, uint64_t timestamp);
96 
107  virtual std::string send_soft_init(fhicl::ParameterSet const& ps, uint64_t timeout, uint64_t timestamp);
108 
119  virtual std::string send_reinit(fhicl::ParameterSet const& ps, uint64_t timeout, uint64_t timestamp);
120 
131  virtual std::string send_start(art::RunID runNumber, uint64_t timeout, uint64_t timestamp);
132 
142  virtual std::string send_pause(uint64_t timeout, uint64_t timestamp);
143 
153  virtual std::string send_resume(uint64_t timeout, uint64_t timestamp);
154 
164  virtual std::string send_stop(uint64_t timeout, uint64_t timestamp);
165 
174  virtual std::string send_shutdown(uint64_t timeout);
175 
182  virtual std::string send_status();
183 
191  virtual std::string send_report(std::string const& which);
192 
199  virtual std::string send_legal_commands();
200 
208  virtual std::string send_register_monitor(std::string const& monitor_fhicl);
209 
217  virtual std::string send_unregister_monitor(std::string const& label);
218 
227  virtual std::string send_trace_get(std::string const& name);
228 
243  virtual std::string send_trace_set(std::string const& name, std::string const& type, std::string const& mask);
244 
253  virtual std::string send_meta_command(std::string const& command, std::string const& argument);
254 
264  virtual std::string send_rollover_subrun(uint64_t seq, uint32_t subrunNumber);
265 
270  bool GetStatus() { return running_.load(); }
271 
285  virtual std::string add_config_archive_entry(std::string const& key, std::string const& value);
286 
295  virtual std::string clear_config_archive();
296 
297 private:
300 
301 public:
306 
307 protected:
308  int _id;
309  std::atomic<bool> running_;
310 };
311 } // namespace artdaq
312 
313 #ifndef EXTERN_C_FUNC_DECLARE_START
314 #define EXTERN_C_FUNC_DECLARE_START extern "C" {
315 #endif
316 
317 #define DEFINE_ARTDAQ_COMMANDER(klass) \
318  EXTERN_C_FUNC_DECLARE_START \
319  std::unique_ptr<artdaq::CommanderInterface> make(fhicl::ParameterSet const& ps, \
320  artdaq::Commandable& commandable) \
321  { \
322  return std::unique_ptr<artdaq::CommanderInterface>(new klass(ps, commandable)); \
323  } \
324  }
325 
326 #endif /* artdaq_ExternalComms_CommanderInterface.hh */
327 
328 // Local Variables:
329 // mode: c++
330 // End:
virtual std::string send_shutdown(uint64_t timeout)
Using the transport mechanism, send a shutdown command
This interface defines the functions used to transfer data between artdaq applications.
Commandable is the base class for all artdaq components which implement the artdaq state machine...
Definition: Commandable.hh:20
fhicl::WrappedTable< Config > Parameters
Used for ParameterSet validation (if desired)
virtual std::string send_resume(uint64_t timeout, uint64_t timestamp)
Using the transport mechanism, send a resume command
virtual std::string send_init(fhicl::ParameterSet const &ps, uint64_t timeout, uint64_t timestamp)
Using the transport mechanism, send an init command
virtual std::string clear_config_archive()
Using the transport mechanism, send a clear_config_archive command
virtual std::string send_report(std::string const &which)
Using the transport mechanism, send a report command
fhicl::Atom< std::string > commanderPluginType
&quot;commanderPluginType&quot; (REQUIRED): The type of Commander plugin to load
int _id
ID Number of this Commander.
virtual std::string send_register_monitor(std::string const &monitor_fhicl)
Using the transport mechanism, send a register_monitor command
virtual std::string send_stop(uint64_t timeout, uint64_t timestamp)
Using the transport mechanism, send a stop command
virtual std::string send_legal_commands()
Using the transport mechanism, send a legal_commands command
virtual std::string send_meta_command(std::string const &command, std::string const &argument)
Using the transport mechanism, send an send_meta_command command
virtual ~CommanderInterface()
Default virtual Destructor.
artdaq::Commandable & _commandable
Reference to the Commandable that this Commander Commands.
virtual std::string send_rollover_subrun(uint64_t seq, uint32_t subrunNumber)
Using the transport mechanism, send a send_rollover_subrun command
virtual std::string send_trace_get(std::string const &name)
Using the transport mechanism, send an send_trace_get command
virtual std::string add_config_archive_entry(std::string const &key, std::string const &value)
Using the transport mechanism, send an add_config_archive_entry command
CommanderInterface(const fhicl::ParameterSet &ps, artdaq::Commandable &commandable)
CommanderInterface Constructor.
virtual std::string send_unregister_monitor(std::string const &label)
Using the transport mechanism, send an unregister_monitor command
CommanderInterface & operator=(const CommanderInterface &)=delete
Copy Assignment operator is deleted.
virtual std::string send_soft_init(fhicl::ParameterSet const &ps, uint64_t timeout, uint64_t timestamp)
Using the transport mechanism, send a soft_init command
Configuration of the CommanderInterface. May be used for parameter validation
virtual void run_server()=0
run_server is the main work loop for the Commander.
virtual std::string send_status()
Using the transport mechanism, send a status command
bool GetStatus()
Determine whether the Commander plugin is ready to accept commands
virtual std::string send_pause(uint64_t timeout, uint64_t timestamp)
Using the transport mechanism, send a pause command
virtual std::string send_trace_set(std::string const &name, std::string const &type, std::string const &mask)
Using the transport mechanism, send an send_trace_msgfacility_set command
virtual std::string send_start(art::RunID runNumber, uint64_t timeout, uint64_t timestamp)
Using the transport mechanism, send a start command
std::atomic< bool > running_
Whether the server is running and able to respond to requests.
virtual std::string send_reinit(fhicl::ParameterSet const &ps, uint64_t timeout, uint64_t timestamp)
Using the transport mechanism, send a reinit command