G4ZMQServer Class Reference

#include "G4ZMQServer.hh"

Inheritance diagram for G4ZMQServer:

Public Member Functions
	G4ZMQServer ()
	~G4ZMQServer ()
void	SetEndpoint (const G4String &endpoint)
G4String	GetEndpoint () const
void	SetDebug (G4bool flag)
virtual G4UIsession *	SessionStart ()
virtual void	PauseSessionStart (const G4String &message)
virtual G4int	ReceiveG4cout (const G4String &coutString)
virtual G4int	ReceiveG4cerr (const G4String &cerrString)

Private Member Functions
G4String	GetCommand (const G4String &input)
virtual void	ExecuteCommand (const G4String &command)
virtual G4bool	GetHelpChoice (G4int &)
virtual void	ExitHelp () const

Private Attributes
G4bool	qdebug_
G4String	endpoint_
G4UItcsh *	shell_

Detailed Description

Definition at line 36 of file G4ZMQServer.hh.

Constructor & Destructor Documentation

G4ZMQServer::G4ZMQServer

(

)

Definition at line 74 of file G4ZMQServer.cc.

References endpoint_, qdebug_, and shell_.

{
  endpoint_ = "tcp://127.0.0.1:5555";
  qdebug_ = false;
  shell_= new G4UItcsh();
  shell_-> SetLsColor(BLUE, RED);

  ::ui_manager = G4UImanager::GetUIpointer();
  ::ui_manager-> SetSession(this);
  ::ui_manager-> SetCoutDestination(this);

  ::qexit = false;
}

G4ZMQServer::~G4ZMQServer

(

)

Definition at line 89 of file G4ZMQServer.cc.

References shell_.

{
  delete shell_;
}

Member Function Documentation

void G4ZMQServer::ExecuteCommand ( const G4String &  command )

privatevirtual

Definition at line 263 of file G4ZMQServer.cc.

Referenced by SessionStart().

{
  auto rc = ::ui_manager-> ApplyCommand(command);
  auto pcode = rc % 100;
  auto status = rc - pcode;

  G4UIcommand* cmd = nullptr;
  if( status != fCommandSucceeded ) cmd = FindCommand(command);

  switch ( status ) {
  case fCommandSucceeded:
    break;
  case fCommandNotFound:
    G4cerr << "command <" << ::ui_manager-> SolveAlias(command)
           << "> not found" << G4endl;
    break;
  case fIllegalApplicationState:
    G4cerr << "illegal application state -- command refused" << G4endl;
    break;
  case fParameterOutOfRange:
    G4cerr << "Parameter is out of range" << G4endl;
   break;
  case fParameterOutOfCandidates:
    G4cerr << "Parameter is out of candidate list (index "
           << pcode << ")" << G4endl;
    G4cerr << "Candidates : "
           << cmd-> GetParameter(pcode)-> GetParameterCandidates()
           << G4endl;
    break;
  case fParameterUnreadable:
    G4cerr << "Parameter is wrong type and/or is not omittable (index "
           << pcode << ")" << G4endl;
    break;
  case fAliasNotFound:
    break;
  default:
    G4cerr << "command refused (" << status << ")" << G4endl;
    break;
 }
}

void G4ZMQServer::ExitHelp ( ) const

privatevirtual

Definition at line 311 of file G4ZMQServer.cc.

{
}

G4String G4ZMQServer::GetCommand ( const G4String &  input )

private

Definition at line 203 of file G4ZMQServer.cc.

References shell_.

Referenced by SessionStart().

{
  const std::string nullstr = "";
  G4String cmdstr = input;

  G4String cstr = cmdstr.strip(G4String::leading);
  if ( cstr.length() == 0 ) {
    cmdstr = nullstr;

  // define built-in shell commands...
  } else if ( cstr(0) == '#' ) {
    G4cout << cstr << G4endl;
    cmdstr = nullstr;

  } else if ( cstr == "ls" || cstr.substr(0,3) == "ls " ) {
    ListDirectory(cstr);
    cmdstr = nullstr;

  } else if ( cstr == "lc" || cstr.substr(0,3) == "lc " ) {
    shell_-> ListCommand(cstr.remove(0,2));
    cmdstr = nullstr;

  } else if (cstr == "pwd" ) {
    G4cout << "Current Command Directory : "
           << GetCurrentWorkingDirectory() << G4endl;
    cmdstr = nullstr;

  } else if ( cstr == "cwd" ) {
    shell_-> ShowCurrentDirectory();
    cmdstr = nullstr;

  } else if (cstr == "cd" || cstr.substr(0,3) == "cd " ) {
    ChangeDirectoryCommand(cstr);
    shell_-> SetCurrentDirectory(GetCurrentWorkingDirectory());
    cmdstr = nullstr;

  } else if ( cstr == "help" || cstr.substr(0,5) == "help " ) {
    TerminalHelp(cstr);
    cmdstr = nullstr;

  } else if ( cstr(0) == '?' ) {
    ShowCurrent(cstr);
    cmdstr = nullstr;

  } else if ( cstr == "history" ) {
    auto nh= ::ui_manager-> GetNumberOfHistory();
    for (auto i = 0; i < nh; i++) {
      G4cout << i << ": " << ::ui_manager->GetPreviousCommand(i) << G4endl;
    }
    cmdstr = nullstr;

  } else if ( cstr == "exit" ) {
    ::qexit = true;
    cmdstr = nullstr;
  }

  return ModifyToFullPathCommand(cmdstr);
}

G4String G4ZMQServer::GetEndpoint ( ) const

inline

Definition at line 71 of file G4ZMQServer.hh.

References endpoint_.

{
  return endpoint_;
}

G4bool G4ZMQServer::GetHelpChoice ( G4int &  )

privatevirtual

Definition at line 305 of file G4ZMQServer.cc.

{
  return true;
}

void G4ZMQServer::PauseSessionStart ( const G4String &  message )

virtual

Definition at line 174 of file G4ZMQServer.cc.

{
}

G4int G4ZMQServer::ReceiveG4cerr ( const G4String &  cerrString )

virtual

Definition at line 191 of file G4ZMQServer.cc.

References qdebug_.

{
  if ( qdebug_ ) {
    std::cerr << cerrString << std::flush;
  }

  ::cout_stream << cerrString << std::flush;

  return 0;
}

G4int G4ZMQServer::ReceiveG4cout ( const G4String &  coutString )

virtual

Definition at line 179 of file G4ZMQServer.cc.

References qdebug_.

{
  if ( qdebug_ ) {
    std::cout << coutString << std::flush;
  }

  ::cout_stream << coutString << std::flush;

  return 0;
}

G4UIsession * G4ZMQServer::SessionStart ( )

virtual

Definition at line 95 of file G4ZMQServer.cc.

References endpoint_, ExecuteCommand(), GetCommand(), message(), and qdebug_.

{
  zmq::context_t context(1);
  zmq::socket_t socket( context, ZMQ_REP );
  socket.bind(endpoint_);

  enum { kBufferSize = 4096 };
  char buffer[kBufferSize];

  while ( ! ::qexit ) {
    if ( qdebug_ ) {
      std::cout << "@@ Waiting..." << std::endl;
    }

    // waiting command
    zmq::message_t request;
    G4bool qok = socket.recv(&request);
    if ( qok ==  false ) ::ThrowException("G4ZMQSever: socket recv error");
    auto end_pos = request.size();
    if ( end_pos >= kBufferSize  ) end_pos = kBufferSize - 1;
    std::memcpy(buffer, request.data(), end_pos);
    buffer[end_pos] = '\0';
    std::string cmd_str = buffer;

    if ( qdebug_ ) {
      std::cout << "@@ Recv=" << cmd_str << "<<" << std::endl;
    }

    // store output & send back response
    ::cout_stream.str("");

    if ( cmd_str == "@@ping" ) {
      G4cout << "pong" << G4endl;

    } else if ( cmd_str == "@@debug") {
      qdebug_ = true;
      G4cout << "G4ZMQ debug activated" << G4endl;

    } else if ( cmd_str == "@@nodebug") {
      qdebug_ = false;
      G4cout << "G4ZMQ debug deactivated" << G4endl;

    } else if ( cmd_str == "@@get_command_tree" ) {
      auto cwd_name = GetCurrentWorkingDirectory();
      auto cwd_tree = FindDirectory(cwd_name.c_str());
      ::command_list = "";
      ::GetCommandTree(cwd_tree);
      G4cout << ::command_list << std::flush;

    } else if ( cmd_str == "@@get_fullcommand_tree" ) {
      auto root = ::ui_manager-> GetTree();
      ::command_list = "";
      ::GetCommandTree(root);
      G4cout << ::command_list << std::flush;

    } else if ( cmd_str == "help" ) {
      G4cout << "help <command>" << G4endl;

    } else {
      G4String new_command = GetCommand(cmd_str);
      if ( qdebug_ ) {
        std::cout << ::black_str << "@@ Cmd="
                  << new_command << "<<" << std::endl;
      }
      ExecuteCommand(new_command);
    }

    std::string reply = ::cout_stream.str();
    size_t cout_size = reply.size();
    zmq::message_t message(cout_size);
    std::strncpy((char*)message.data(), reply.c_str(), cout_size);
    qok = socket.send(message);
    if ( qok ==  false ) ::ThrowException("G4ZMQServer: socket send error");
  }

  return nullptr;
}

void G4ZMQServer::SetDebug ( G4bool  flag )

inline

Definition at line 76 of file G4ZMQServer.hh.

References qdebug_.

{
  qdebug_ = flag;
}

void G4ZMQServer::SetEndpoint ( const G4String &  endpoint )

inline

Definition at line 66 of file G4ZMQServer.hh.

References endpoint_.

{
  endpoint_ = endpoint;
}

Member Data Documentation

G4String G4ZMQServer::endpoint_

private

Definition at line 54 of file G4ZMQServer.hh.

Referenced by G4ZMQServer(), GetEndpoint(), SessionStart(), and SetEndpoint().

G4bool G4ZMQServer::qdebug_

private

Definition at line 53 of file G4ZMQServer.hh.

Referenced by G4ZMQServer(), ReceiveG4cerr(), ReceiveG4cout(), SessionStart(), and SetDebug().

G4UItcsh* G4ZMQServer::shell_

private

Definition at line 55 of file G4ZMQServer.hh.

Referenced by G4ZMQServer(), GetCommand(), and ~G4ZMQServer().

---

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

• geant4.10.06.p01/environments/zmq/zmq/G4ZMQServer.hh
• geant4.10.06.p01/environments/zmq/zmq/G4ZMQServer.cc