artdaq  v3_04_01
CommanderInterface.hh
1 #ifndef artdaq_ExternalComms_CommanderInterface_hh
2 #define artdaq_ExternalComms_CommanderInterface_hh
3 
4 #include "artdaq/DAQdata/Globals.hh"
5 #include "fhiclcpp/ParameterSet.h"
6 #include "artdaq/Application/Commandable.hh"
7 #include "cetlib/compiler_macros.h"
8 
9 
10 namespace artdaq
11 {
16  {
17  public:
21  struct Config
22  {
24  fhicl::Atom<int> id{ fhicl::Name{"id"}, fhicl::Comment{"The unique ID associated with this Commander plugin. (ex. XMLRPC Port number)"}, 0 };
26  fhicl::Atom<std::string> commanderPluginType{ fhicl::Name{"commanderPluginType"}, fhicl::Comment{"String identifying the name of the CommanderInterface plugin to load"} };
27  };
29  using Parameters = fhicl::WrappedTable<Config>;
30 
36  CommanderInterface(const fhicl::ParameterSet& ps, artdaq::Commandable& commandable)
37  : _commandable(commandable)
38  , _id(ps.get<int>("id", 0))
39  {}
40 
44  CommanderInterface(const CommanderInterface&) = delete;
45 
51 
55  virtual ~CommanderInterface();
56 
85  virtual void run_server() = 0;
86 
94  virtual std::string send_init(fhicl::ParameterSet, uint64_t, uint64_t);
95 
103  virtual std::string send_soft_init(fhicl::ParameterSet, uint64_t, uint64_t);
104 
112  virtual std::string send_reinit(fhicl::ParameterSet, uint64_t, uint64_t);
113 
121  virtual std::string send_start(art::RunID, uint64_t, uint64_t);
122 
130  virtual std::string send_pause(uint64_t, uint64_t);
131 
139  virtual std::string send_resume(uint64_t, uint64_t);
140 
148  virtual std::string send_stop(uint64_t, uint64_t);
149 
157  virtual std::string send_shutdown(uint64_t);
158 
165  virtual std::string send_status();
166 
173  virtual std::string send_report(std::string);
174 
181  virtual std::string send_legal_commands();
182 
189  virtual std::string send_register_monitor(std::string);
190 
197  virtual std::string send_unregister_monitor(std::string);
198 
206  virtual std::string send_trace_get(std::string);
207 
218  virtual std::string send_trace_set(std::string, std::string, uint64_t);
219 
226  virtual std::string send_meta_command(std::string, std::string);
227 
235  virtual std::string send_rollover_subrun(uint64_t, uint32_t);
236 
241  bool GetStatus() { return running_.load(); }
242 
254  virtual std::string add_config_archive_entry(std::string, std::string);
255 
264  virtual std::string clear_config_archive();
265 
266  private:
267 
268  public:
273 
274  protected:
275  int _id;
276  std::atomic<bool> running_;
277  };
278 }
279 
280 #ifndef EXTERN_C_FUNC_DECLARE_START
281 #define EXTERN_C_FUNC_DECLARE_START extern "C" {
282 #endif
283 
284 #define DEFINE_ARTDAQ_COMMANDER(klass) \
285  EXTERN_C_FUNC_DECLARE_START \
286  std::unique_ptr<artdaq::CommanderInterface> make(fhicl::ParameterSet const & ps, \
287  artdaq::Commandable& commandable) { \
288  return std::unique_ptr<artdaq::CommanderInterface>(new klass(ps, commandable)); \
289 }}
290 
291 
292 #endif /* artdaq_ExternalComms_CommanderInterface.hh */
293 
294 // Local Variables:
295 // mode: c++
296 // End:
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_report(std::string)
Using the transport mechanism, send a report command
virtual std::string send_soft_init(fhicl::ParameterSet, uint64_t, uint64_t)
Using the transport mechanism, send a soft_init command
virtual std::string send_unregister_monitor(std::string)
Using the transport mechanism, send an unregister_monitor command
virtual std::string clear_config_archive()
Using the transport mechanism, send a clear_config_archive command
fhicl::Atom< std::string > commanderPluginType
&quot;commanderPluginType&quot; (REQUIRED): The type of Commander plugin to load
virtual std::string send_meta_command(std::string, std::string)
Using the transport mechanism, send an send_meta_command command
int _id
ID Number of this Commander.
virtual std::string send_resume(uint64_t, uint64_t)
Using the transport mechanism, send a resume command
virtual std::string send_rollover_subrun(uint64_t, uint32_t)
Using the transport mechanism, send a send_rollover_subrun command
virtual std::string send_legal_commands()
Using the transport mechanism, send a legal_commands command
virtual std::string send_trace_set(std::string, std::string, uint64_t)
Using the transport mechanism, send an send_trace_msgfacility_set command
virtual std::string send_start(art::RunID, uint64_t, uint64_t)
Using the transport mechanism, send a start command
virtual ~CommanderInterface()
Default virtual Destructor.
artdaq::Commandable & _commandable
Reference to the Commandable that this Commander Commands.
virtual std::string send_stop(uint64_t, uint64_t)
Using the transport mechanism, send a stop command
virtual std::string send_init(fhicl::ParameterSet, uint64_t, uint64_t)
Using the transport mechanism, send an init command
CommanderInterface(const fhicl::ParameterSet &ps, artdaq::Commandable &commandable)
CommanderInterface Constructor.
virtual std::string send_reinit(fhicl::ParameterSet, uint64_t, uint64_t)
Using the transport mechanism, send a reinit command
CommanderInterface & operator=(const CommanderInterface &)=delete
Copy Assignment operator is deleted.
virtual std::string send_shutdown(uint64_t)
Using the transport mechanism, send a shutdown command
virtual std::string send_register_monitor(std::string)
Using the transport mechanism, send a register_monitor 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_trace_get(std::string)
Using the transport mechanism, send an send_trace_get command
virtual std::string add_config_archive_entry(std::string, std::string)
Using the transport mechanism, send an add_config_archive_entry command
std::atomic< bool > running_
Whether the server is running and able to respond to requests.
virtual std::string send_pause(uint64_t, uint64_t)
Using the transport mechanism, send a pause command