KM3NETDAQ::JClient Class Reference

Client data structure. More...

#include <JClient.hh>

Public Types
enum	JMode {   UNKNOWN = -1, SLEEP = 0, ACTIVE, IGNORE = -2,   ILLEGAL = -3 }
	Client modi. More...

Public Member Functions
	JClient ()
	Default constructor. More...
	JClient (const std::string &__name, const std::string &__hostname, const std::string &__start_command="")
	Constructor. More...
void	start ()
	Start process. More...
void	stop (const int signal=-9)
	Stop process. More...
const std::string &	getName () const
	Get name of run control client. More...
const std::string &	getHostname () const
	Get host name of run control client. More...
const std::string &	getFullName () const
	Get full name of run control client. More...
const std::string &	getStartCommand () const
	Get start command of run control client. More...
bool	isSleep () const
	Check sleep mode. More...
bool	isActive () const
	Check active mode. More...
bool	isIgnore () const
	Check ignore mode. More...
bool	isIllegal () const
	Check illegal mode. More...
bool	update (const JNET::JTag &tag, const std::string &buffer)
	Update client. More...
const std::string &	getStatename () const
	Get name of current state. More...
const std::string &	getEventname () const
	Get name of last event. More...
int	getEventnumber () const
	Get number of last event. More...
bool	getAlive () const
	Get alive status. More...
void	setAlive (const bool alive)
	Set alive status. More...
JMode	getMode () const
	Get mode. More...
void	setMode (const JMode mode)
	Set mode. More...
int	getBorn () const
	Get born count. More...
int	getDied () const
	Get died count. More...

Static Public Attributes
static std::string	SERVER
	host name of message server More...
static std::string	LOGGER
	host name of message logger More...

Protected Member Functions
void	configure ()
	Configure client parameters. More...

Protected Attributes
std::string	name
std::string	hostname
JLANG::JString	start_command
std::string	full_name
JMode	mode
int	born
int	died
bool	is_alive
std::string	state_name
std::string	event_name
int	event_number

Friends
std::istream &	operator>> (std::istream &in, JClient &client)
	Read client from input. More...
std::ostream &	operator<< (std::ostream &out, const JClient &client)
	Write client to output. More...

Detailed Description

Client data structure.

Definition at line 27 of file JClient.hh.

Member Enumeration Documentation

enum KM3NETDAQ::JClient::JMode

Client modi.

Enumerator
UNKNOWN
SLEEP
ACTIVE
IGNORE
ILLEGAL

Definition at line 38 of file JClient.hh.

{ UNKNOWN = -1, SLEEP = 0, ACTIVE, IGNORE = -2, ILLEGAL = -3 };

Constructor & Destructor Documentation

KM3NETDAQ::JClient::JClient ( )

inline

Default constructor.

Definition at line 44 of file JClient.hh.

              :
      name         (),
      hostname     (),
      start_command(),
      mode(UNKNOWN),
      born(0),
      died(0),
      is_alive(false),
      state_name("?"),
      event_name("?"),
      event_number(-1)
    {}

KM3NETDAQ::JClient::JClient ( const std::string &  __name, const std::string &  __hostname, const std::string &  __start_command = ""  )

inline

Constructor.

Parameters

__name	name of client
__hostname	host name
__start_command	start command

Definition at line 65 of file JClient.hh.

                                                   :
      name         (__name),
      hostname     (__hostname),
      start_command(__start_command),
      mode(UNKNOWN),
      born(0),
      died(0),
      is_alive(false),
      state_name("?"),
      event_name("?"),
      event_number(-1)
    {
      configure();
    }

Member Function Documentation

void KM3NETDAQ::JClient::start ( )

inline

Start process.

The start command is issued on the (remote) host.

Definition at line 87 of file JClient.hh.

    {
      using JSYSTEM::JShell;

      if (start_command != "") {

        JShell& shell = JShell::getInstance();

        shell << start_command << std::endl;
        shell.flush();
      }
    }

void KM3NETDAQ::JClient::stop ( const int  signal = -9 )

inline

Stop process.

A kill command is issued on the (remote) host. To determine the PID for the kill command, the start command is compared to the output of a ps command on the (remote) host.

Parameters

signal

signal

Definition at line 109 of file JClient.hh.

    {
      using namespace std;
      using JSYSTEM::JShell;

      if (start_command != "") {

        const string header  = "__header___";
        const string trailer = "__trailer__";

        ostringstream os;

        os << "ssh " << hostname << ' '
           << "\""
           << "echo" << ' ' << header << ";"
           << "ps hax -o '%p %a'"     << ";"
           << "echo" << ' ' << trailer
           << "\"";

        JShell& shell = JShell::getInstance();

        shell << os.str() << endl;

        os.str("");

        string buffer;

        while (getline(shell, buffer) && buffer.find(header)  == string::npos) {}

        istringstream is;

        while (getline(shell, buffer) && buffer.find(trailer) == string::npos) {

          is.clear();
          is.str(buffer);

          int pid;

          if (is >> pid && getline(is >> ws, buffer)) {
            if (start_command.find(buffer) != string::npos) {
              os << "ssh " << hostname << ' '
                 << "\""
                 << "kill " << signal << " " << pid << " </dev/null >&/dev/null"
                 << "\"";
            }
          }
        }

        shell.flush();

        if (os.str() != "") {
          shell << os.str() << endl;
          shell.flush();
        }
      }
    }

const std::string& KM3NETDAQ::JClient::getName ( ) const

inline

Get name of run control client.

Returns

name

Definition at line 172 of file JClient.hh.

    {
      return name;
    }

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

inline

Get host name of run control client.

Returns

host name

Definition at line 183 of file JClient.hh.

    {
      return hostname;
    }

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

inline

Get full name of run control client.

Returns

full name

Definition at line 194 of file JClient.hh.

    {
      return full_name;
    }

const std::string& KM3NETDAQ::JClient::getStartCommand ( ) const

inline

Get start command of run control client.

Returns

name

Definition at line 205 of file JClient.hh.

    {
      return start_command;
    }

bool KM3NETDAQ::JClient::isSleep ( ) const

inline

Check sleep mode.

Returns

true if sleep; else false

Definition at line 216 of file JClient.hh.

    {
      return mode == SLEEP;
    }

bool KM3NETDAQ::JClient::isActive ( ) const

inline

Check active mode.

Returns

true if active; else false

Definition at line 227 of file JClient.hh.

    {
      return mode == ACTIVE;
    }

bool KM3NETDAQ::JClient::isIgnore ( ) const

inline

Check ignore mode.

Returns

true if ignore; else false

Definition at line 238 of file JClient.hh.

    {
      return mode == IGNORE;
    }

bool KM3NETDAQ::JClient::isIllegal ( ) const

inline

Check illegal mode.

Returns

true if illegal; else false

Definition at line 249 of file JClient.hh.

    {
      return mode == ILLEGAL;
    }

bool KM3NETDAQ::JClient::update ( const JNET::JTag &  tag, const std::string &  buffer  )

inline

Update client.

The client parameters are updated according to the ControlHost tag and message.

Parameters

tag	tag
buffer	message

Returns

true if OK; else false

Definition at line 263 of file JClient.hh.

    {
      using namespace std;
      using JLANG::JWhiteSpacesFacet;
        
      if        (tag == JNET::DISPTAG_Born) {

        this->is_alive  = true;
        this->born     += 1;
        
        return true;

      } else if (tag == JNET::DISPTAG_Died) {
        
        this->is_alive  = false;
        this->died     += 1;
        
        return true;

      } else if (tag == RC_REPLY) {
        
        string   key;
        string   ip;
        string   name;
        JEvent_t event;
        string   state;
        
        istringstream is(buffer);
        
        const locale loc(is.getloc(), new JWhiteSpacesFacet(is.getloc(), TOKEN_DELIMETER));
          
        is.imbue(loc);
        
        if (is >> key >> ip >> name >> event >> state && key == RUN_CONTROL_CLIENT) {

          this->event_name   = event.getName();
          this->event_number = event.getNumber();
          this->state_name   = state;

          return true;
        }
      }

      return false;
    }

const std::string& KM3NETDAQ::JClient::getStatename ( ) const

inline

Get name of current state.

Returns

state name

Definition at line 315 of file JClient.hh.

    {
      return state_name;
    }

const std::string& KM3NETDAQ::JClient::getEventname ( ) const

inline

Get name of last event.

Returns

event name

Definition at line 326 of file JClient.hh.

    {
      return event_name;
    }

int KM3NETDAQ::JClient::getEventnumber ( ) const

inline

Get number of last event.

Returns

event number

Definition at line 337 of file JClient.hh.

    {
      return event_number;
    }

bool KM3NETDAQ::JClient::getAlive ( ) const

inline

Get alive status.

Returns

true if alive; else false

Definition at line 348 of file JClient.hh.

    {
      return is_alive;
    }

void KM3NETDAQ::JClient::setAlive ( const bool  alive )

inline

Set alive status.

Parameters

alive

alive

Definition at line 359 of file JClient.hh.

    {
      is_alive = alive;
    }

JMode KM3NETDAQ::JClient::getMode ( ) const

inline

Get mode.

Returns

mode

Definition at line 370 of file JClient.hh.

    {
      return mode;
    }

void KM3NETDAQ::JClient::setMode ( const JMode  mode )

inline

Set mode.

Parameters

mode

mode

Definition at line 381 of file JClient.hh.

    {
      this->mode = mode;
    }

int KM3NETDAQ::JClient::getBorn ( ) const

inline

Get born count.

Returns

number of times born

Definition at line 392 of file JClient.hh.

    {
      return born;
    }

int KM3NETDAQ::JClient::getDied ( ) const

inline

Get died count.

Returns

number of times died

Definition at line 403 of file JClient.hh.

    {
      return died;
    }

void KM3NETDAQ::JClient::configure ( )

inlineprotected

Configure client parameters.

In this, the following tokens in the start command are substituted: $HOST$ by <host name>; $NAME$ by <process name>; $SERVER$ by JClient::SERVER; $LOGGER$ by JClient::LOGGER; $ARGS$ by part following last '/' in <process name>;

Definition at line 463 of file JClient.hh.

    {
      using std::string;

      full_name = KM3NETDAQ::getFullName(hostname, name);

      start_command = start_command.trim();
      start_command = start_command.replace("  ", " ");

      start_command.replace("$HOST$",   hostname);
      start_command.replace("$NAME$",   name);
      start_command.replace("$SERVER$", SERVER);
      start_command.replace("$LOGGER$", LOGGER);

      string::size_type pos = name.find_last_of(CLIENTNAME_DELIMETER);
                    
      if (pos != string::npos) {
        start_command.replace("$ARGS$", name.substr(pos + 1));
      }
    }

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in, JClient &  client  )

friend

Read client from input.

Parameters

in	istream
client	client

Returns

istream

Definition at line 416 of file JClient.hh.

    {
      in >> client.name;
      in >> client.hostname;

      if (in) {

        getline(in >> std::ws, client.start_command);

        in.clear();    // clear error state of input stream if no start command is available.

        client.configure();
      }

      return in;
    }

std::ostream& operator<< ( std::ostream &  out, const JClient &  client  )

friend

Write client to output.

Parameters

out	ostream
client	client

Returns

ostream

Definition at line 441 of file JClient.hh.

    {
      out << client.name;
      out << ' ';
      out << client.hostname;
      out << ' ';
      out << client.start_command;

      return out;
    }

Member Data Documentation

std::string KM3NETDAQ::JClient::SERVER

static

host name of message server

Author

mdejonghost name of message server

Definition at line 31 of file JClient.hh.

std::string KM3NETDAQ::JClient::LOGGER

static

host name of message logger

Definition at line 32 of file JClient.hh.

std::string KM3NETDAQ::JClient::name

protected

Definition at line 485 of file JClient.hh.

std::string KM3NETDAQ::JClient::hostname

protected

Definition at line 486 of file JClient.hh.

JLANG::JString KM3NETDAQ::JClient::start_command

protected

Definition at line 487 of file JClient.hh.

std::string KM3NETDAQ::JClient::full_name

protected

Definition at line 488 of file JClient.hh.

JMode KM3NETDAQ::JClient::mode

protected

Definition at line 489 of file JClient.hh.

int KM3NETDAQ::JClient::born

protected

Definition at line 490 of file JClient.hh.

int KM3NETDAQ::JClient::died

protected

Definition at line 491 of file JClient.hh.

bool KM3NETDAQ::JClient::is_alive

protected

Definition at line 492 of file JClient.hh.

std::string KM3NETDAQ::JClient::state_name

protected

Definition at line 493 of file JClient.hh.

std::string KM3NETDAQ::JClient::event_name

protected

Definition at line 494 of file JClient.hh.

int KM3NETDAQ::JClient::event_number

protected

Definition at line 495 of file JClient.hh.

---

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

• JClient.hh
• JClient.cc