KM3NETDAQ::JDAQClient Class Reference

Run control client base class. More...

#include <JDAQClient.hh>

Inheritance diagram for KM3NETDAQ::JDAQClient:

Public Member Functions
	JDAQClient (const std::string &name)
	Constructor. More...
	JDAQClient (const std::string &name, const std::string &server, JLogger *logger, const int level)
	Constructor. More...
virtual bool	enter (const JArgs &args)
	Enter the state machine. More...
virtual bool	enter ()
	Enter the state machine. More...
virtual bool	exit ()
	Exit the state machine. More...
const std::string &	getFullName () const
	Get full name of this run control client. More...
const JNET::JTag &	getUniqueTag () const
	Get unique tag of this run control client. More...
int	getEventNumber () const
	Get last event number. More...
bool	isRunning () const
	Check if this client is in runnig state. More...
void	replaceEvent (const JNET::JTag &oldTag, const JNET::JTag &newTag, JDAQEvent_t &event)
	Replace tag of given event in event table. More...
JDAQEvent_t *	findEvent (const JNET::JTag &tag, const std::string &event_name)
	Find event in event table. More...
template<class T >
void	addParameter (const char option, T &parameter)
	Add parameter to parser used in method enter(). More...
template<class T >
void	addParameter (const char option, T &parameter, const T &value)
	Add parameter to parser used in method enter(). More...
long long int	getClockDelay () const
	Get total delay time. More...
const std::string &	getHostname () const
	Get hostname. More...
long long int	getClockInterval () const
	Get interval time. More...
void	setClockInterval (const long long int interval_us)
	Set interval time. More...
void	resetClock ()
	Reset clock. More...
void	setSelect ()
	Set the file descriptor mask for the select call. More...
virtual void	setSelect (JFileDescriptorMask &mask) const
	Set the file descriptor mask for the select call. More...
virtual void	actionSelect (const JFileDescriptorMask &mask)
	Action method following last select call. More...
virtual void	actionRunning ()
	This method is repeatedly called when this client machine is in state Running and the clock interval time is non-zero. More...
virtual void	actionInput (int length, const char *buffer)
	This method is called at ev_input. More...
virtual bool	filter (const std::string &tag, int length, const char *buffer)
	Filter message. More...
void	run ()
	Run as run control client following command messages via JNET::JControlHost. More...
void	run (const int port)
	Run for ever. More...
void	run (std::istream &in)
	Run client with commands from input stream (e.g for debugging). More...

Static Public Attributes
static const int	TIMEOUT_S = 1
	time out of update [s] More...

Protected Attributes
JSharedPointer< JControlHost >	server
	message server More...
JMessageLogger	logger
	message logger More...

Private Member Functions
void	update ()
	Update state machine. More...
void	update (const JNET::JTag &tag, int length, const char *buffer)
	Update state machine. More...
void	configure ()
	Configure client. More...
void	enterState (const CHSM::state &state, const CHSM::event &event)
	Action when entering state. More...
virtual void	actionCheck (int length, const char *buffer)
	This method is called at ev_check and reports a system check by mimicing an enter state action. More...
void	execute (action __action, const CHSM::event &__event)
	The method to execute the action. More...

Private Attributes
JEventTable	eventTable
	event table More...
std::string	hostname
std::string	full_name
JNET::JTag	unique_tag
JTimekeeper	clock
	central clock More...
JSelectReader	select
	select call More...
JParser	parser
	parser method enter() More...
int	event_number
	number of last event More...

Detailed Description

Run control client base class.

This base class implements the protocol for the communication with the central run control program. This protocol is based on JNET::JControlHost tags and CHSM event names. The method run can be used to process JNET::JControlHost messages and accordingly update the state machine.

For client specific events with a designated JNET::JControlHost tag, the corresponding entry in the event table should be replaced. This should be done in the constructor of the derived class using method JDAQClient::replaceEvent.

The method JDAQClient::addParameter can be used to add a parameter of the derived class to the list that is parsed in method enter.

The method JDAQClient::filter can be overwritten so that a specific action is made before the corresponding message is processed by the state machine. The message is ignored if this method returns true, else it is normally processed.

The method JDAQClient::setSelect can be used to set the file descriptor mask of the select call and the method actionSelect can be used to take client specific actions following the select call.

If the clock interval is non-zero, the method JDAQClient::actionRunning is repeatedly called when this client machine is in state Running. The clock interval can be set using method JDAQClient::setClockInterval.

Definition at line 88 of file JDAQClient.hh.

Constructor & Destructor Documentation

KM3NETDAQ::JDAQClient::JDAQClient ( const std::string &  name )

inline

Constructor.

Parameters

name	name of client

Definition at line 97 of file JDAQClient.hh.

                                      :
      JDAQStateMachine(name),
      parser(),
      event_number(-1)
    {
      configure();
    }

KM3NETDAQ::JDAQClient::JDAQClient ( const std::string &  name, const std::string &  server, JLogger *  logger, const int  level  )

inline

Constructor.

Parameters

name	name of client
server	name of command message server
logger	pointer to logger
level	debug level

Definition at line 114 of file JDAQClient.hh.

                                         :
      JDAQStateMachine(name),
      parser(),
      event_number(-1)
    {
      this->logger = JMessageLogger(logger, name, level);

      try {
        this->server.reset(new JControlHost(server));
      }
      catch(JControlHostException& error) {
        JErrorStream(this->logger) << error;
      }

      configure();
    }

Member Function Documentation

virtual bool KM3NETDAQ::JDAQClient::enter ( const JArgs &  args )

inlinevirtual

Enter the state machine.

This overloaded method enter reproduces the constructor. All necessary input is parsed from the list of arguments. In case of an error, the state machine is not entered.

Parameters

args	array of command line arguments

Definition at line 143 of file JDAQClient.hh.

    {
      using namespace std;

      string  server;
      string  logger;
      int     level;
      bool    use_cout;

      try {
        
        parser['H'] = make_field(server)    = "localhost";
        parser['M'] = make_field(logger)    = "localhost";
        parser['d'] = make_field(level)     = 0;
        parser['c'] = make_field(use_cout);
        
        if (parser.read(args) != 0) {
          return false;
        }
      }
      catch(const exception &error) {
        cerr << error.what() << endl;
        return false;
      }

      try {

        JLogger* out = NULL;

        if (use_cout)
          out = new JStreamLogger(cout);
        else
          out = new JControlHostLogger(logger);
        
        this->logger = JMessageLogger(out, getName(), level);

        this->server.reset(new JControlHost(server));

        return enter();
      } 
      catch(const JControlHostException& error) {
        cerr << error << endl;
        return false;
      }
    }

virtual bool KM3NETDAQ::JDAQClient::enter ( )

inlinevirtual

Enter the state machine.

This method activates the subscription to JNET::JControlHost messages. In case of an error, the state machine is not entered.

Reimplemented in KM3NETDAQ::JDAQDriver.

Definition at line 195 of file JDAQClient.hh.

    {
      using namespace std;

      if (server.is_valid() && logger.is_valid()) {

        try {
          
          server->Subscribe(getSubscription(eventTable));
          server->SendMeAlways();
          server->MyId(getFullName());
          
          return CHSM::machine::enter();
        }
        catch(const JControlHostException& error) {
          JErrorStream(logger) << error;
        }

      } else {
        cerr << "Message server or logger not properly initialised." << endl;
      }

      return false;
    }

virtual bool KM3NETDAQ::JDAQClient::exit ( )

inlinevirtual

Exit the state machine.

This method releases the various resources.

Definition at line 225 of file JDAQClient.hh.

    {
      try { 
        if (server.is_valid()) server.reset(NULL);
      }
      catch(const JControlHostException& error) {
      }

      try {
        if (logger.is_valid()) logger.reset(NULL);
      }
      catch(const JControlHostException& error) {
      }

      return CHSM::machine::exit();
    }

const std::string& KM3NETDAQ::JDAQClient::getFullName ( ) const

inline

Get full name of this run control client.

Returns

full name

Definition at line 248 of file JDAQClient.hh.

    {
      return full_name;
    }

const JNET::JTag& KM3NETDAQ::JDAQClient::getUniqueTag ( ) const

inline

Get unique tag of this run control client.

Returns

unique tag

Definition at line 259 of file JDAQClient.hh.

    {
      return unique_tag;
    }

int KM3NETDAQ::JDAQClient::getEventNumber ( ) const

inline

Get last event number.

Returns

event number

Definition at line 270 of file JDAQClient.hh.

    {
      return event_number;
    }

bool KM3NETDAQ::JDAQClient::isRunning ( ) const

inline

Check if this client is in runnig state.

Returns

true if running; else false

Definition at line 281 of file JDAQClient.hh.

    {
      return Main.RunControl.Operational.Running.active();
    }

void KM3NETDAQ::JDAQClient::replaceEvent ( const JNET::JTag &  oldTag, const JNET::JTag &  newTag, JDAQEvent_t &  event  )

inline

Replace tag of given event in event table.

Parameters

oldTag	old tag
newTag	new tag
event	event

Definition at line 294 of file JDAQClient.hh.

    {
      eventTable.replace(oldTag, newTag, event);
    }

JDAQEvent_t* KM3NETDAQ::JDAQClient::findEvent ( const JNET::JTag &  tag, const std::string &  event_name  )

inline

Find event in event table.

Parameters

tag	tag
event_name	event name

Returns

pointer to event or NULL

Definition at line 309 of file JDAQClient.hh.

    {
      JEventTable::const_iterator i = eventTable.find(tag, event_name);
            
      if (i != eventTable.end())
        return i->second;
      else
        return NULL;
    }

template<class T >

void KM3NETDAQ::JDAQClient::addParameter ( const char  option, T &  parameter  )

inline

Add parameter to parser used in method enter().

Parameters

option	option
parameter	parameter

Definition at line 327 of file JDAQClient.hh.

    {
      parser[option] = make_field(parameter);
    }

template<class T >

void KM3NETDAQ::JDAQClient::addParameter ( const char  option, T &  parameter, const T &  value  )

inline

Add parameter to parser used in method enter().

Parameters

option	option
parameter	parameter
value	default value

Definition at line 341 of file JDAQClient.hh.

    {
      parser[option] = make_field(parameter) = value;
    }

long long int KM3NETDAQ::JDAQClient::getClockDelay ( ) const

inline

Get total delay time.

Returns

delay time [us]

Definition at line 352 of file JDAQClient.hh.

    {
      return clock.getDelay();
    }

const std::string& KM3NETDAQ::JDAQClient::getHostname ( ) const

inline

Get hostname.

Returns

host name

Definition at line 363 of file JDAQClient.hh.

    {
      return hostname;
    }

long long int KM3NETDAQ::JDAQClient::getClockInterval ( ) const

inline

Get interval time.

Returns

interval time [us]

Definition at line 374 of file JDAQClient.hh.

    {
      return clock.getInterval();
    }

void KM3NETDAQ::JDAQClient::setClockInterval ( const long long int  interval_us )

inline

Set interval time.

Parameters

interval_us

interval time [us]

Definition at line 385 of file JDAQClient.hh.

    {
      clock.setInterval(interval_us);
    }

void KM3NETDAQ::JDAQClient::resetClock ( )

inline

Reset clock.

Definition at line 394 of file JDAQClient.hh.

    {
      clock.reset();
    }

void KM3NETDAQ::JDAQClient::setSelect ( )

inline

Set the file descriptor mask for the select call.

Definition at line 403 of file JDAQClient.hh.

    {
      select.reset();
      
      setSelect(select.getReaderMask());

      select.setReaderMask(*server);
    }

virtual void KM3NETDAQ::JDAQClient::setSelect ( JFileDescriptorMask &  mask ) const

inlinevirtual

Set the file descriptor mask for the select call.

This implementation does nothing but may be redefined by the derived class.

Parameters

mask	file descriptor mask

Reimplemented in KM3NETDAQ::JDataWriter, and KM3NETDAQ::MonitorRouter.

Definition at line 419 of file JDAQClient.hh.

    {}

virtual void KM3NETDAQ::JDAQClient::actionSelect ( const JFileDescriptorMask &  mask )

inlinevirtual

Action method following last select call.

This implementation does nothing but may be redefined by the derived class.

Parameters

mask	file descriptor mask

Reimplemented in KM3NETDAQ::DataQueue, KM3NETDAQ::JDataWriter, and KM3NETDAQ::MonitorRouter.

Definition at line 429 of file JDAQClient.hh.

    {}

virtual void KM3NETDAQ::JDAQClient::actionRunning ( )

inlinevirtual

This method is repeatedly called when this client machine is in state Running and the clock interval time is non-zero.

This implementation does nothing but may be redefined by the derived class. Care has to be taken so that the time needed to execute this method should be less than the specified clock interval time (see method setClockInterval()).

Reimplemented in JDataFilter, KM3NETDAQ::JDataWriter, KM3NETDAQ::JDOMSimulator, KM3NETDAQ::DataQueue, KM3NETDAQ::JEventGenerator, KM3NETDAQ::MonitorRouter, and AcousticDataFilter.

Definition at line 440 of file JDAQClient.hh.

    {}

virtual void KM3NETDAQ::JDAQClient::actionInput ( int  length, const char *  buffer  )

inlinevirtual

This method is called at ev_input.

Parameters

length	length of data
buffer	pointer to data

Reimplemented in AcousticDataFilter.

Definition at line 450 of file JDAQClient.hh.

    {
      using namespace std;

      JProperties properties(JEquationParameters("=", ";", "", ""), 1);

      int level = this->logger.getLevel();

      properties["debug"] = level;

      properties.read(string(buffer, length));

      this->logger.setLevel(level);
    }

virtual bool KM3NETDAQ::JDAQClient::filter ( const std::string &  tag, int  length, const char *  buffer  )

inlinevirtual

Filter message.

The filter method can be overloaded so that a specific action is made before the corresponding message is processed by the state machine. The message is ignored if true is returned, else it is normally processed.

Parameters

tag	tag
length	number of characters
buffer	message

Returns

skip message or not

Definition at line 477 of file JDAQClient.hh.

    {
      return false;
    }

void KM3NETDAQ::JDAQClient::run ( )

inline

Run as run control client following command messages via JNET::JControlHost.

This method can be called once the state machine is entered. It returns when the state machine is exited. If the clock interval is non-zero, the method actionRunning() is repeatedly called when this client machine is in state Running. The file descriptor mask can be set to interrupt the timeout of the select call and clock method wait() in this calling sequence (see methods setSelect() and actionSelect()).

Definition at line 493 of file JDAQClient.hh.

    {
      using namespace std;

      while (active()) {

        try {

          setSelect();

          if (select(JTimeval(TIMEOUT_S,0)) > 0) {
            
            if (select.hasReaderMask(*server)) {
              update();
            }
            
            actionSelect(select.getReaderMask());

          } else {

            continue;
          }


          if (isRunning() && clock.getInterval() != 0LL) {

            long long int numberOfCalls = 0;
            
            clock.reset();
            
            do {
              
              ++numberOfCalls;
              
              setSelect();

              if (clock.wait(select.getReaderMask())) {
                
                if (select.hasReaderMask(*server)) {
                  update();
                }

                actionSelect(select.getReaderMask());

              } else {

                try {
                  actionRunning();
                }
                catch(const exception& error) {
                  logger.error(error.what());
                }             
              }

            } while (isRunning());
            
            if (numberOfCalls != 0) {
              JNoticeStream(logger) << "Delay per call " << clock.getDelay() / numberOfCalls / 1000 << " ms";
            }
          }
        }
        catch(const exception& error) {
          JErrorStream(logger) << "method run(): " << error.what();
        }
      }
    }

void KM3NETDAQ::JDAQClient::run ( const int  port )

inline

Run for ever.

This method can be used when the run control client is started before the run control (e.g. at boot time of the host processor). This method should be called before the state machine is entered. It launches a server which accepts a JNET::JControlHost connection from a designated application e.g. the JDAQClientStarter.cc program. The state machine is entered using the available data in the JNET::JControlHost message. After the state machine is exited, it accepts a new a JNET::JControlHost connection.

Parameters

port	port number

Definition at line 573 of file JDAQClient.hh.

    {
      JControlHostServer server(port);

      for ( ; ; ) {

        JControlHost* ps = server.AcceptClient();
        
        ps->Connected();

        JNET::JPrefix prefix;

        ps->WaitHead(prefix);

        const int length = prefix.getSize();

        char* buffer = new char[length];
        
        ps->GetFullData(buffer, length);        
        ps->PutFullData(prefix.toString(), buffer, length);

        delete ps;

        enter(JArgs(std::string(buffer, length)));

        delete [] buffer;
        
        run();

        exit();
      }
    }

void KM3NETDAQ::JDAQClient::run ( std::istream &  in )

inline

Run client with commands from input stream (e.g for debugging).

Example input format:

<tag> <event name>[#data];
<tag> <event name>[#data];

Parameters

in	input stream

Definition at line 618 of file JDAQClient.hh.

    {
      using std::string;

      string tag;
      string buffer;

      while (in >> tag && getline(in, buffer, ';')) {
        update(tag, buffer.length(), buffer.data());
      }
    }

void KM3NETDAQ::JDAQClient::update ( )

inlineprivate

Update state machine.

This method waits for a message from JNET::JControlHost server.

Definition at line 643 of file JDAQClient.hh.

    {
      JNET::JPrefix prefix;
      
      server->WaitHead(prefix);
      
      const int length = prefix.getSize();
      
      char* buffer = new char[length];
      
      server->GetFullData(buffer, length);
      
      if (!filter(prefix.toString(), length, buffer)) {
        update(prefix.toString(), length, buffer);
      }

      delete [] buffer;
    }

void KM3NETDAQ::JDAQClient::update ( const JNET::JTag &  tag, int  length, const char *  buffer  )

inlineprivate

Update state machine.

Parameters

tag	tag
length	number of characters
buffer	message

Definition at line 670 of file JDAQClient.hh.

    {
      using namespace std;
      using namespace JLANG;

      string::size_type pos = 0;

      while (pos != (string::size_type) length && TOKEN_DELIMETER.find(*(buffer + pos)) == string::npos) {
        ++pos;
      }

      JEvent_t event = JEvent_t::toValue(string(buffer, pos));
      
      JString event_name(event.getName());

      event_number = event.getNumber();
      event_name   = event_name.trim();     // remove white spaces, if any

      while (pos != (string::size_type) length && TOKEN_DELIMETER.find(*(buffer + pos)) != string::npos) {
        ++pos;
      }


      JEventTable::const_iterator i = eventTable.find(tag, event_name);
      
      if (i != eventTable.end()) {

        // redirect all I/O

        JErrorStream    error(logger);

        JRedirectStream redirect[] = { JRedirectStream(cin,  JLANG::null),
                                       JRedirectStream(cout, JLANG::null),
                                       JRedirectStream(cerr, error) };

        if (redirect[0] &&
            redirect[1] &&
            redirect[2]) {

          (*(i->second))(length - pos, buffer + pos);
        }
        
      } else {

        JErrorStream(logger) << "Unknown key <" << JEventTable::getKey(tag,event_name) << ">";
      }
    }

void KM3NETDAQ::JDAQClient::configure ( )

inlineprivate

Configure client.

This method is used to setup the event table.

Definition at line 723 of file JDAQClient.hh.

    {
      using namespace std;
      using namespace JNET;

      hostname   = JSYSTEM::getHostname();

      full_name  = KM3NETDAQ::getFullName (hostname, getName());
      unique_tag = KM3NETDAQ::getUniqueTag(hostname, getName());
      
      for (JTag buffer[] = { RC_CMD, unique_tag, DISPTAG_UNDEFINED }, *tag = buffer; *tag != DISPTAG_UNDEFINED; ++tag) {

        eventTable.insert(*tag, ev_init);
        eventTable.insert(*tag, ev_configure);
        eventTable.insert(*tag, ev_start);
        eventTable.insert(*tag, ev_pause);
        eventTable.insert(*tag, ev_continue);
        eventTable.insert(*tag, ev_stop);
        eventTable.insert(*tag, ev_reset);
        eventTable.insert(*tag, ev_quit);
        eventTable.insert(*tag, ev_off);
        
        eventTable.insert(*tag, ev_check);
        eventTable.insert(*tag, ev_input);

        eventTable.insert(*tag, ev_recover);
      }

      JControlHost::Throw(true);

      setClockInterval(TIMEOUT_S * 1000000LL);
    }

void KM3NETDAQ::JDAQClient::enterState ( const CHSM::state &  state, const CHSM::event &  event  )

inlineprivate

Action when entering state.

This method provides for the hand shaking with the run control program.

Parameters

state	entered state
event	event that triggered transition

Definition at line 764 of file JDAQClient.hh.

    {
      std::ostringstream os;
      
      os << getFullName()
         << getTokenDelimeter() 
         << JEvent_t(event.name(), event_number)
         << getTokenDelimeter() 
         << getStateName(state.name());

      server->PutFullString(RC_REPLY, os.str());
    }

virtual void KM3NETDAQ::JDAQClient::actionCheck ( int  length, const char *  buffer  )

inlineprivatevirtual

This method is called at ev_check and reports a system check by mimicing an enter state action.

Parameters

length	number of characters
buffer	message

Definition at line 785 of file JDAQClient.hh.

    {
      if (Main.RunControl.Error.active()) {

        enterState(Main.RunControl.Error, ev_check);

      } else {
        
        for (CHSM::parent::iterator state = Main.RunControl.Operational.begin(); state != Main.RunControl.Operational.end(); ++state) {

          if (state->active()) {

            // mimic enter state

            enterState(*state, ev_check);
          }
        }
      }
    }

void KM3NETDAQ::JDAQClient::execute ( action  __action, const CHSM::event &  __event  )

inlineprivate

The method to execute the action.

Parameters

__action	pointer to action method
__event	event that triggered the action

Definition at line 812 of file JDAQClient.hh.

    {
      try {

        const JDAQStateMachine::ev_daq_event& event = dynamic_cast<const JDAQStateMachine::ev_daq_event&>(__event);

        (this->*__action)(event->length, event->buffer);
      }
      catch(const std::exception& error) {
        logger.error(error.what());
        logger.error("Trigger ev_error.");
        ev_error();
      }
    }

Member Data Documentation

const int KM3NETDAQ::JDAQClient::TIMEOUT_S = 1

static

time out of update [s]

Definition at line 631 of file JDAQClient.hh.

JSharedPointer<JControlHost> KM3NETDAQ::JDAQClient::server

protected

message server

Definition at line 635 of file JDAQClient.hh.

JMessageLogger KM3NETDAQ::JDAQClient::logger

protected

message logger

Definition at line 636 of file JDAQClient.hh.

JEventTable KM3NETDAQ::JDAQClient::eventTable

private

event table

Definition at line 828 of file JDAQClient.hh.

std::string KM3NETDAQ::JDAQClient::hostname

private

Definition at line 829 of file JDAQClient.hh.

std::string KM3NETDAQ::JDAQClient::full_name

private

Definition at line 830 of file JDAQClient.hh.

JNET::JTag KM3NETDAQ::JDAQClient::unique_tag

private

Definition at line 831 of file JDAQClient.hh.

JTimekeeper KM3NETDAQ::JDAQClient::clock

private

central clock

Definition at line 832 of file JDAQClient.hh.

JSelectReader KM3NETDAQ::JDAQClient::select

private

select call

Definition at line 833 of file JDAQClient.hh.

JParser KM3NETDAQ::JDAQClient::parser

private

parser method enter()

Definition at line 834 of file JDAQClient.hh.

int KM3NETDAQ::JDAQClient::event_number

private

number of last event

Definition at line 835 of file JDAQClient.hh.

---

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

• JDAQClient.hh