artdaq  v3_02_01
artdaq::xmlrpc_commander Class Reference

The xmlrpc_commander class serves as the XMLRPC server run in each artdaq application. More...

#include <artdaq/ExternalComms/xmlrpc_commander.hh>

Inheritance diagram for artdaq::xmlrpc_commander:
artdaq::CommanderInterface

Public Member Functions

 xmlrpc_commander (fhicl::ParameterSet ps, artdaq::Commandable &commandable)
 xmlrpc_commander Constructor More...
 
void run_server () override
 Run the XMLRPC server.
 
std::string send_register_monitor (std::string monitor_fhicl) override
 Send a register_monitor command over XMLRPC More...
 
std::string send_unregister_monitor (std::string monitor_label) override
 Send an unregister_monitor command over XMLRPC More...
 
- Public Member Functions inherited from artdaq::CommanderInterface
 CommanderInterface (const fhicl::ParameterSet &ps, artdaq::Commandable &commandable)
 CommanderInterface Constructor. More...
 
 CommanderInterface (const CommanderInterface &)=delete
 Copy Constructor is deleted.
 
CommanderInterfaceoperator= (const CommanderInterface &)=delete
 Copy Assignment operator is deleted. More...
 
virtual ~CommanderInterface ()
 Default virtual Destructor.
 
virtual std::string send_init (fhicl::ParameterSet, uint64_t, uint64_t)
 Using the transport mechanism, send an init command More...
 
virtual std::string send_soft_init (fhicl::ParameterSet, uint64_t, uint64_t)
 Using the transport mechanism, send a soft_init command More...
 
virtual std::string send_reinit (fhicl::ParameterSet, uint64_t, uint64_t)
 Using the transport mechanism, send a reinit command More...
 
virtual std::string send_start (art::RunID, uint64_t, uint64_t)
 Using the transport mechanism, send a start command More...
 
virtual std::string send_pause (uint64_t, uint64_t)
 Using the transport mechanism, send a pause command More...
 
virtual std::string send_resume (uint64_t, uint64_t)
 Using the transport mechanism, send a resume command More...
 
virtual std::string send_stop (uint64_t, uint64_t)
 Using the transport mechanism, send a stop command More...
 
virtual std::string send_shutdown (uint64_t)
 Using the transport mechanism, send a shutdown command More...
 
virtual std::string send_status ()
 Using the transport mechanism, send a status command More...
 
virtual std::string send_report (std::string)
 Using the transport mechanism, send a report command More...
 
virtual std::string send_legal_commands ()
 Using the transport mechanism, send a legal_commands command More...
 
virtual std::string send_trace_get (std::string)
 Using the transport mechanism, send an send_trace_get command More...
 
virtual std::string send_trace_set (std::string, std::string, uint64_t)
 Using the transport mechanism, send an send_trace_msgfacility_set command More...
 
virtual std::string send_meta_command (std::string, std::string)
 Using the transport mechanism, send an send_meta_command command More...
 
virtual std::string send_rollover_subrun (uint64_t)
 Using the transport mechanism, send a send_rollover_subrun command More...
 

Public Attributes

std::timed_mutex mutex_
 XMLRPC mutex.
 
std::unique_ptr
< xmlrpc_c::serverAbyss > 
server
 XMLRPC server.
 
- Public Attributes inherited from artdaq::CommanderInterface
artdaq::Commandable_commandable
 Reference to the Commandable that this Commander Commands. More...
 

Additional Inherited Members

- Protected Attributes inherited from artdaq::CommanderInterface
int _id
 ID Number of this Commander.
 

Detailed Description

The xmlrpc_commander class serves as the XMLRPC server run in each artdaq application.

Definition at line 17 of file xmlrpc_commander.hh.

Constructor & Destructor Documentation

artdaq::xmlrpc_commander::xmlrpc_commander ( fhicl::ParameterSet  ps,
artdaq::Commandable commandable 
)

xmlrpc_commander Constructor

Parameters
psParameterSet used for configuring xmlrpc_commander
commandableartdaq::Commandable object to send transition commands to
 xmlrpc_commander accepts the following Parameters:
  id: For XMLRPC, the ID should be the port to listen on
  server_url: When sending, location of XMLRPC server
* 

Definition at line 928 of file xmlrpc_commander.cc.

Member Function Documentation

std::string artdaq::xmlrpc_commander::send_register_monitor ( std::string  monitor_fhicl)
overridevirtual

Send a register_monitor command over XMLRPC

Parameters
monitor_fhiclFHiCL string contianing monitor configuration
Returns
Return status from XMLRPC

Reimplemented from artdaq::CommanderInterface.

Definition at line 1080 of file xmlrpc_commander.cc.

std::string artdaq::xmlrpc_commander::send_unregister_monitor ( std::string  monitor_label)
overridevirtual

Send an unregister_monitor command over XMLRPC

Parameters
monitor_labelLabel of the monitor to unregister
Returns
Return status from XMLRPC

Reimplemented from artdaq::CommanderInterface.

Definition at line 1109 of file xmlrpc_commander.cc.


The documentation for this class was generated from the following files: