KM3NETDAQ::JDAQDriver Class Reference

Simple driver for run control clients. More...

#include <JDAQDriver.hh>

Inheritance diagram for KM3NETDAQ::JDAQDriver:

Public Member Functions
	JDAQDriver (const std::string &name, const std::string &server, JLogger *logger, const int level, const int timeout_s)
	Constructor. More...
virtual bool	enter ()
	Enter the state machine. More...
void	actionExit ()
	Exit the state machine. More...
void	enterState (const CHSM::state &state, const CHSM::event &event)
	Action when entering state. More...
bool	update (const bool no_wait)
	Update client list with incoming ControlHost message. More...
virtual void	actionStart (int, const char *)
virtual void	actionStop (int, const char *)
void	run ()
	Run driver with user input. More...
void	run (std::istream &in)
	Run driver. More...
void	update ()
	Update client list with incoming ControlHost messages until the client list is synchronised with the current state or until the timeout. More...
void	synchronise ()
	Synchronise clients. More...
void	filter (const std::string &target="")
	Filter client list by putting failing clients to sleep. More...
virtual bool	enter (const JArgs &args)
	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 (const int port)
	Run for ever. More...

Public Attributes
int	timeout_s
	timeout of state transitions [s] More...

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

Static Protected Member Functions
static void	copy (std::istream &in, std::ostream &out, const char eol= '\n')
	Copy data from input to output stream. More...

Protected Attributes
JClientList	clientList
bool	is_alive
std::string	rc_log
JSharedPointer< JControlHost >	server
	message server More...
JMessageLogger	logger
	message logger More...

Detailed Description

Simple driver for run control clients.

This class can be used to start a set of run control clients, trigger events and eventually stop the clients.

Definition at line 35 of file JDAQDriver.hh.

Constructor & Destructor Documentation

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

inline

Constructor.

Parameters

name	name of driver
server	name of command message server
logger	logger
level	debug level
timeout_s	timeout_s [s]

Definition at line 48 of file JDAQDriver.hh.

                                             :
      JDAQClient(name, server, logger, level),
      timeout_s (timeout_s),
      is_alive  (false)
    {}

Member Function Documentation

virtual bool KM3NETDAQ::JDAQDriver::enter ( )

inlinevirtual

Enter the state machine.

The driver will subscribe to the ControlHost tags corresponding to born, died and reply messages of the clients instead of the standard tags for run control commands. The clients are started after the driver is ready to receive ControlHost messages. In case of an error, a message is printed on the terminal and the state machine is not entered.

Reimplemented from KM3NETDAQ::JDAQClient.

Definition at line 67 of file JDAQDriver.hh.

    {
      using namespace std;
      using namespace JLANG;
      using namespace JNET;

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

        try {
          
          server->Subscribe(JSubscriptionAll(RC_REPLY)     + 
                            JSubscriptionAll(RC_LOG)       + 
                            JSubscriptionAll(DISPTAG_Born) + 
                            JSubscriptionAll(DISPTAG_Died));
          server->SendMeAlways();
          server->MyId(getFullName());

          // check alive of this driver

          for (int i = 0; i != timeout_s && !is_alive; ) {
            if (!update(true)) {
              sleep(1);
              ++i;
            }
          }
          
          if (is_alive) {

            {
              // redirect standard output to message logger

              //JDebugStream    out(logger);
              //JRedirectStream redirect(cout, out);
              
              clientList.start();
              
              for (int i = 0; i != timeout_s; ++i) {

                while (update(true)) {}

                if (clientList.count() >= clientList.count(JClient::ACTIVE))
                  break;
                else
                  sleep(1);
              }
            }

            if (clientList.count() != clientList.count(JClient::ACTIVE)) {
              for (JClientList::const_iterator i = clientList.begin(); i != clientList.end(); ++i) {
                if (i->isActive() && i->getBorn() <= i->getDied()) {
                  JWarningStream(logger) << "client " << i->getFullName() << " did not start.";
                }
              }
            }

            return CHSM::machine::enter();

          } else {
            cerr << "Timeout at subscription." << endl;
          }
        }
        catch(const JControlHostException& error) {
          cerr << error << endl;
        }

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

      return false;
    }

void KM3NETDAQ::JDAQDriver::actionExit ( )

inline

Exit the state machine.

This method waits for the clients to terminate using the died message generated by ControlHost. In case of a timeout, the process is terminated by calling the method stop() of the corresponding client.

Definition at line 146 of file JDAQDriver.hh.

    {
      using namespace std;
      using namespace JLANG;

      for (int i = 0; i != timeout_s; ++i) {

        while (update(true)) {}

        if (clientList.count() == 0)
          break;
        else
          sleep(1);
      }

      if (clientList.count() != 0) {
        JWarningStream(logger) << "Timeout at transition " << "exit(); forced stop.";
      }
      
      // redirect standard output to message logger

      //JDebugStream    out(logger);
      //JRedirectStream redirect(cout, out);

      clientList.stop();
    }

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

inline

Action when entering state.

This method waits for all clients to produce the enter state message. In case of a timeout, no specific action is taken but an error message is logged.

Parameters

state	entered state
event	event that triggered transition

Definition at line 182 of file JDAQDriver.hh.

    {
      for (int i = 0; i != timeout_s && clientList.count(state) < clientList.count(JClient::ACTIVE); ) {
        if (!update(true)) {
          sleep(1);
          ++i;
        }
      }

      if (clientList.count(state) < clientList.count(JClient::ACTIVE)) {
        JWarningStream(logger) << "Timeout at transition " << event.name() << " to state " << state.name(); 
      }
    }

bool KM3NETDAQ::JDAQDriver::update ( const bool  no_wait )

inline

Update client list with incoming ControlHost message.

This method receives and processes a message. The client list is updated accordingly. If the no-wait option is set to true, it returns in the absence of a pending message immediately. The return value is then false. If the no-wait option is set to false, it waits until the next message is received.

Parameters

no_wait

wait option

Returns

true if message received; else false

Definition at line 208 of file JDAQDriver.hh.

    {
      using namespace std;
      using namespace JNET;
      using JLANG::JWhiteSpacesFacet;

      try {

        string tag;
        int    length = 0;

        if ( no_wait && server->CheckHead(tag, length) <= 0) { return false; }
        if (!no_wait && server->WaitHead (tag, length) <  0) { return false; }
        
        char* data= new char[length];
        
        server->GetFullData(data, length);
        
        const string buffer(data, length);

        delete [] data;
        
        JDebugStream(logger) << "Got message " << tag << ' ' << buffer;
        
        if (tag == RC_LOG) {

          rc_log = buffer;

        } else if (buffer.find(getFullName()) != string::npos) {
          
          if      (tag == DISPTAG_Born)
            is_alive  = true;
          else if (tag == DISPTAG_Died)
            is_alive  = false;
          
        } else {

          JClientList::iterator i = clientList.find(buffer);
          
          if (i != clientList.end()) {

            i->update(tag, buffer);

          } else {

            JErrorStream(logger) << "Message fom illegal client " << buffer;

            try {

              if (tag == DISPTAG_Born ||
                  tag == DISPTAG_Died ||
                  tag == RC_REPLY) {

                string key, hostname, name;
                
                istringstream is(buffer);
      
                const locale loc(is.getloc(), new JWhiteSpacesFacet(is.getloc(), TOKEN_DELIMETER));
      
                is.imbue(loc);
                
                if (is >> key >> hostname >> name && key == RUN_CONTROL_CLIENT) {

                  JClient client(name, hostname);

                  client.update(tag, buffer);
                  client.setMode(JClient::ILLEGAL);
            
                  clientList.insert(client);
                  
                  JWarningStream(logger) << "Added illegal client " << client.getFullName();

                } else {
                  throw JIOException("JClient: Error reading " + buffer);
                }
              }
            }
            catch(const JException& error) {
              JErrorStream(logger) << error;
            }
          }
        }

        return true;
      }
      catch(const JControlHostException& error) {
        JErrorStream(logger) << error;
      }

      return false;
    }

virtual void KM3NETDAQ::JDAQDriver::actionStart ( int  , const char *    )

inlinevirtual

Definition at line 300 of file JDAQDriver.hh.

    {
      rc_log = "";
    }

virtual void KM3NETDAQ::JDAQDriver::actionStop ( int  , const char *    )

inlinevirtual

Definition at line 305 of file JDAQDriver.hh.

    {
      if (rc_log != "") 
        JNoticeStream(logger) << rc_log;
      else
        JErrorStream (logger) << "Missing message from JDataWriter with tag " << RC_LOG;
    }

void KM3NETDAQ::JDAQDriver::run ( )

inline

Run driver with user input.

Definition at line 316 of file JDAQDriver.hh.

    {
      run(std::cin);
    }

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

inline

Run driver.

Example input format:

# comment line.

process <process name> <host name> [<start command>];

# The following tokens in <start command> will be substituted: 
#   $HOST$    by  <host name>;
#   $NAME$    by  <process name>;
#   $SERVER$  by  JClient::SERVER;
#   $LOGGER$  by  JClient::LOGGER;
#   $ARGS$    by  part following '/' in <process name>;

# enter state machine.

enter

# trigger event
# data can be provided online and mixed with data from a separate file (optional).
# multiple tags should be separated by a new line.

event <event name> {
  [<tag 1> [data]]
  [<tag 2> [data][%<file name>%][data]]
}

# optionally quit before end of input
[quit]

# optionally kill processes that did not properly terminate.
[exit]

Parameters

in	input stream

Definition at line 360 of file JDAQDriver.hh.

    {
      using namespace std;
      
      for (string key; in >> key; ) {

        if (key[0] == '#') {

          in.ignore(numeric_limits<streamsize>::max(), '\n');

        } else if (key == "enter") {
          
          enter();
          
          if (!active()) {
            cerr << "State machine not entered; abort." << endl;
            return;
          }

        } else if (key == "exit") {
          
          timeout_s = 0;
          exit();
          
        } else if (key == "quit") {
          
          break;
          
        } else if (key == "sleep") {

          int sec;

          if (in >> sec) {
            sleep(sec);
          }
          
        } else if (key == "process") {

          string buffer;

          getline(in, buffer, ';');
          
          istringstream is(buffer);
          
          JClient client;
          
          if (is >> client) {

            client.setMode(JClient::ACTIVE);

            if (!clientList.insert(client).second) {
              JWarningStream(logger) << "Process already exists " << client;
            }

          } else {
            JErrorStream(logger) << "Error reading key word process.";
          }

        } else if (key == "event" || key == "event*") {
          
          JEvent_t   event;
          char       c;
          string     buffer;
          const char eol = '\n';
          
          if (in >> event >> c && c == '{' && getline(in, buffer, '}')) {

            JDAQEvent_t* pev = findEvent(RC_CMD, event.getName());
            
            if (pev != NULL) {

              if (pev->active() || key == "event*") {

                istringstream is(buffer);
                
                for (string tag; is >> tag; ) {
                  
                  ostringstream os;

                  os << event << getTokenDelimeter();

                  copy(is, os, eol);

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

                if (key != "event*") {
                  (*pev)(0, NULL);   // trigger driver
                }

              } else {
                JErrorStream(logger) << "Inactive event " << event;
              }

            } else {
              JErrorStream(logger) << "Unknown event " << event;
            }

          } else {
            JErrorStream(logger) << "Error reading key word event.";
          }

        } else if (key == "print") {

          for (JClientList::const_iterator i = clientList.begin(); i != clientList.end(); ++i) {
            JNoticeStream(logger) << i->getFullName()     << ' '
                                  << i->getStartCommand() << ' '
                                  << i->getAlive()        << ' '
                                  << i->getStatename();
          }

        } else if (key == "filter") {

          string client;
          string buffer;

          getline(in, buffer, ';');

          for (istringstream is(buffer); is >> client; ) {
            filter(client);
          }

        } else if (key == "sync") {

          synchronise();
          
        } else {

          JErrorStream(logger) << "Unknown key: " << key;

          in.ignore(numeric_limits<streamsize>::max(), '\n');
        }
      }
    }

void KM3NETDAQ::JDAQDriver::update ( )

inline

Update client list with incoming ControlHost messages until the client list is synchronised with the current state or until the timeout.

Definition at line 500 of file JDAQDriver.hh.

    {
      using namespace std;

      const CHSM::parent& parent = static_cast<const CHSM::parent&>(Main.RunControl);

      for (CHSM::parent::const_iterator state = parent.begin(); state != parent.end(); ++state) {

        if (state->active()) {
          for (int i = 0; i != timeout_s && clientList.count(*state) < clientList.count(JClient::ACTIVE); ) {
            if (!update(true)) {
              sleep(1);
              ++i;
            }
          }
        }
      }
    }

void KM3NETDAQ::JDAQDriver::synchronise ( )

inline

Synchronise clients.

Definition at line 523 of file JDAQDriver.hh.

    {
      using namespace std;

      const CHSM::parent& parent = static_cast<const CHSM::parent&>(Main.RunControl);

      for (CHSM::parent::const_iterator state = parent.begin(); state != parent.end(); ++state) {

        if (state->active()) {

          if (clientList.count(*state) < clientList.count(JClient::ACTIVE)) {

            JDebugStream(logger) << "Synchronising " << state->name();
            
            for (JClientList::iterator i = clientList.begin(); i != clientList.end(); ++i) {

              if (i->getMode() == JClient::ACTIVE) {
                
                if (!i->getAlive()) {
              
                  try {
                
                    string buffer;
                
                    if (JControlHost::WhereIs(JClient::SERVER, i->getFullName(), buffer) > 0) {

                      i->setAlive(true);

                      if (buffer.find(i->getHostname()) == string::npos) {
                        JErrorStream(logger) << i->getFullName() << " running on " << buffer << " but not alive.";
                      }
                    }
                  }
                  catch(const JControlHostException& error) {
                    JErrorStream(logger) << error;
                  }
                }

                if (i->getAlive() && i->getStatename() != state->name()) {
                  server->PutFullString(KM3NETDAQ::getUniqueTag(i->getHostname(), i->getName()), ev_check.name()); 
                }
              }
            }
            
            
            for (int i = 0; i != timeout_s && clientList.count(*state) < clientList.count(JClient::ACTIVE); ) {
              if (!update(true)) {
                sleep(1);
                ++i;
              }
            }
            
            if (clientList.count(*state) < clientList.count(JClient::ACTIVE)) {
              JWarningStream(logger) << "Timeout at synchronisation.";
            }
          }
        }
      }
    }

void KM3NETDAQ::JDAQDriver::filter ( const std::string &  target = "" )

inline

Filter client list by putting failing clients to sleep.

In this, only clients with names that contain the given character sequence are considered.

Parameters

target

target name of client(s)

Definition at line 590 of file JDAQDriver.hh.

    {
      const CHSM::parent& parent = static_cast<const CHSM::parent&>(Main.RunControl);

      for (CHSM::parent::const_iterator state = parent.begin(); state != parent.end(); ++state) {

        if (state->active()) {

          for (JClientList::iterator i = clientList.begin(); i != clientList.end(); ++i) {

            if (target == "" || i->getName().find(target) != std::string::npos) {

              if (!i->getAlive() || i->getStatename() != state->name()) {

                JNoticeStream(logger) << "Put to sleep " << i->getFullName();

                i->setMode(JClient::SLEEP);
              }
            }
          }
        }
      }
    }

static void KM3NETDAQ::JDAQDriver::copy ( std::istream &  in, std::ostream &  out, const char  eol = '\n'  )

inlinestaticprotected

Copy data from input to output stream.

Tagged file names are recursively expanded.

Parameters

in	input stream
out	output stream
eol	end of line

Definition at line 630 of file JDAQDriver.hh.

    {
      using namespace std;

      string buffer; 

      if (getline(in, buffer, eol)) {

        for (string::size_type pos = 0; pos < buffer.length(); ) {
          
          string::size_type lpos = buffer.substr(pos).find(FILENAME_PREFIX);
          string::size_type rpos = buffer.substr(pos).find(FILENAME_POSTFIX);
          
          if (lpos != string::npos && 
              rpos != string::npos) {
            
            out << buffer.substr(pos, lpos);
            
            lpos += FILENAME_PREFIX.length();
            pos  += lpos;
            
            ifstream file(buffer.substr(pos, rpos - lpos).c_str());
            
            copy(file, out, '\0');
            
            rpos += FILENAME_POSTFIX.length();
            pos  += rpos - lpos;
            
          } else {
            
            out << buffer.substr(pos);
            
            pos  += buffer.substr(pos).length();
          }
        }
      }
    }

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

inlinevirtualinherited

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::exit ( )

inlinevirtualinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

Get last event number.

Returns

event number

Definition at line 270 of file JDAQClient.hh.

    {
      return event_number;
    }

bool KM3NETDAQ::JDAQClient::isRunning ( ) const

inlineinherited

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  )

inlineinherited

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  )

inlineinherited

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  )

inlineinherited

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  )

inlineinherited

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

inlineinherited

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

inlineinherited

Get hostname.

Returns

host name

Definition at line 363 of file JDAQClient.hh.

    {
      return hostname;
    }

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

inlineinherited

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 )

inlineinherited

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 ( )

inlineinherited

Reset clock.

Definition at line 394 of file JDAQClient.hh.

    {
      clock.reset();
    }

void KM3NETDAQ::JDAQClient::setSelect ( )

inlineinherited

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

inlinevirtualinherited

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 )

inlinevirtualinherited

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 ( )

inlinevirtualinherited

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  )

inlinevirtualinherited

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  )

inlinevirtualinherited

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 ( const int  port )

inlineinherited

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();
      }
    }

Member Data Documentation

int KM3NETDAQ::JDAQDriver::timeout_s

timeout of state transitions [s]

Definition at line 614 of file JDAQDriver.hh.

JClientList KM3NETDAQ::JDAQDriver::clientList

protected

Definition at line 618 of file JDAQDriver.hh.

bool KM3NETDAQ::JDAQDriver::is_alive

protected

Definition at line 619 of file JDAQDriver.hh.

std::string KM3NETDAQ::JDAQDriver::rc_log

protected

Definition at line 620 of file JDAQDriver.hh.

const int KM3NETDAQ::JDAQClient::TIMEOUT_S = 1

staticinherited

time out of update [s]

Definition at line 631 of file JDAQClient.hh.

JSharedPointer<JControlHost> KM3NETDAQ::JDAQClient::server

protectedinherited

message server

Definition at line 635 of file JDAQClient.hh.

JMessageLogger KM3NETDAQ::JDAQClient::logger

protectedinherited

message logger

Definition at line 636 of file JDAQClient.hh.

---

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

• JDAQDriver.hh