JiveXML::ExternalONCRPCServerSvc Class Reference

This athena service will provide a link to an external ONCRPC server, e.g running as standalone application or in another athena application. More...

#include <ExternalONCRPCServerSvc.h>

Inheritance diagram for JiveXML::ExternalONCRPCServerSvc:

Collaboration diagram for JiveXML::ExternalONCRPCServerSvc:

Public Member Functions
	ExternalONCRPCServerSvc (const std::string &name, ISvcLocator *sl)
	Default constructor.
virtual	~ExternalONCRPCServerSvc ()
	Destructor.
virtual StatusCode	initialize () override
	Gaudi default methods.
virtual StatusCode	finalize () override
	Finalize - called once at the end.

Server methods
std::string	m_hostName
double	m_timeOut
CLIENT *	m_client
virtual StatusCode	UpdateEventForStream (const EventStreamID &evtStreamID, const std::string &event) override
	Put this event as new current event for stream given by name.
StatusCode	GetClient ()
	Obtain a client handle by.
StatusCode	ReleaseClient ()
	Destroy the private client handle.
struct timeval	GetTimeout ()
	Convert timeout double in seconds to struct timeval.

Detailed Description

This athena service will provide a link to an external ONCRPC server, e.g running as standalone application or in another athena application.

It only provides means for streaming events to that server.

Definition at line 23 of file ExternalONCRPCServerSvc.h.

Constructor & Destructor Documentation

ExternalONCRPCServerSvc()

JiveXML::ExternalONCRPCServerSvc::ExternalONCRPCServerSvc	(	const std::string &	name,
		ISvcLocator *	sl )

Default constructor.

Constructor.

Definition at line 16 of file ExternalONCRPCServerSvc.cxx.

                                                                                          :
    base_class ( name, sl ),
    m_client(NULL)
  {
      //declare properties
      declareProperty("Hostname",m_hostName="localhost","The name of the host the external server is running on [ default: \"localhost\" ]");
      declareProperty("Timeout",m_timeOut=10,"Timeout when calling the server in seconds [ default: 10 ]");
  }

~ExternalONCRPCServerSvc()

JiveXML::ExternalONCRPCServerSvc::~ExternalONCRPCServerSvc ( )

virtual

Destructor.

Definition at line 28 of file ExternalONCRPCServerSvc.cxx.

                                                   {
    ATH_MSG_VERBOSE( "Destructor() "  );
  }

Member Function Documentation

finalize()

StatusCode JiveXML::ExternalONCRPCServerSvc::finalize ( )

overridevirtual

Finalize - called once at the end.

• shut down server

Release the client

Definition at line 143 of file ExternalONCRPCServerSvc.cxx.

                                               {
 
    ATH_MSG_VERBOSE( "Finalize()"  );

    ReleaseClient().ignore();
 
    return StatusCode::SUCCESS;
  }

GetClient()

StatusCode JiveXML::ExternalONCRPCServerSvc::GetClient ( )

private

Obtain a client handle by.

• creating a CLIENT object
• pinging the server using NULLPROC

Definition at line 59 of file ExternalONCRPCServerSvc.cxx.

                                               {
 
    ATH_MSG_VERBOSE( "GetClient()"  );
 
    //Try to create client if not there yet
#ifndef __APPLE__
    if (!m_client) m_client = clnt_create(m_hostName.c_str(), ONCRPCSERVERPROG,ONCRPCSERVERVERS, "tcp");
#else
    char proto[] = "tcp";
    if (!m_client) m_client = clnt_create((char*)m_hostName.c_str(), ONCRPCSERVERPROG,ONCRPCSERVERVERS, proto);
#endif    
    //Fail if we still don't have a client
    if (!m_client){
      ATH_MSG_WARNING( "Unable to create client for server on host " << m_hostName << " using TCP/IP "  );
      return StatusCode::FAILURE;
    }
 
// xdr_void is defined inconsistently in xdr.h and gets a warning from gcc8.
#if __GNUC__ >= 8
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Wcast-function-type"
#endif
#if defined(__clang__) && __clang_major__ >= 19
# pragma clang diagnostic push
# pragma clang diagnostic ignored "-Wcast-function-type-mismatch"
#endif
    //Now try pinging the server
    clnt_stat ret = clnt_call(m_client, NULLPROC, (xdrproc_t)xdr_void, NULL,
                             (xdrproc_t)xdr_void, NULL, GetTimeout());
#if defined(__clang__) && __clang_major__ >= 19
# pragma clang diagnostic pop
#endif
#if __GNUC__ >= 8
# pragma GCC diagnostic pop
#endif
 
    //And check for the result
    if (ret != RPC_SUCCESS){
      ATH_MSG_WARNING( "Failed calling the server on host " << m_hostName << " : " << clnt_sperrno(ret)  );
      //Also destroy the client in this case - otherwise we might be stranded
      //with an invalid client object
      ReleaseClient().ignore();
      //and return failure
      return StatusCode::FAILURE;
    } 
 
    //Be verbose on success
    ATH_MSG_VERBOSE( "Successfully connected to server on host " << m_hostName  );
 
    return StatusCode::SUCCESS;
  }

GetTimeout()

struct timeval JiveXML::ExternalONCRPCServerSvc::GetTimeout ( )

private

Convert timeout double in seconds to struct timeval.

Definition at line 114 of file ExternalONCRPCServerSvc.cxx.

                                                    {
    //Declare return value
    struct timeval timeout = { 0, 0 };
    //Catch for negatives
    if (m_timeOut < 0)  return timeout;
    //Get seconds as integer part
    timeout.tv_sec = static_cast<long>(m_timeOut);
    //Get microseconds as fractional part
    timeout.tv_usec = static_cast<long>((m_timeOut - timeout.tv_sec)*1e6);
    //Finally return it
    return timeout;
  }

initialize()

StatusCode JiveXML::ExternalONCRPCServerSvc::initialize ( )

overridevirtual

Gaudi default methods.

Initialize - called once in beginning.

• create server

Try preemtivly creating a client right here - but ignore the result

Definition at line 36 of file ExternalONCRPCServerSvc.cxx.

                                                 {
    ATH_MSG_VERBOSE( "Initialize()"  );
    
    //Initialize Service base
    if (Service::initialize().isFailure()) return StatusCode::FAILURE;
    
     //Initialize message stream level
    msg().setLevel(outputLevel());
    ATH_MSG_VERBOSE( "Output level is set to " << (int)msg().level()  );

    GetClient().ignore();
    
    return StatusCode::SUCCESS;
  }

ReleaseClient()

StatusCode JiveXML::ExternalONCRPCServerSvc::ReleaseClient ( )

private

Destroy the private client handle.

Definition at line 130 of file ExternalONCRPCServerSvc.cxx.

                                                   {
    //Destroy the client
    if (m_client) clnt_destroy(m_client);
    //And set pointer to NULL
    m_client=NULL;
    //For now always return success
    return StatusCode::SUCCESS;
  }

UpdateEventForStream()

StatusCode JiveXML::ExternalONCRPCServerSvc::UpdateEventForStream ( const EventStreamID & evtStreamID, const std::string & eventStr )

overridevirtual

Put this event as new current event for stream given by name.

Implementation of IServerSvc method.

Get one event and put it as the new event for the this stream, which is identified by EventStreamID

Definition at line 159 of file ExternalONCRPCServerSvc.cxx.

                                                                                                                        {
 
    ATH_MSG_VERBOSE( "UpdateEventForStream()"  );
 
    //Check that the event stream id is valid
    if (!evtStreamID.isValid()){
      ATH_MSG_ERROR( "Invalid event stream identifier - cannot add event"  );
      return StatusCode::FAILURE;
    }
 
    //Now create an event C-struct that we can send to the server
    //NOTE: the struct has to be properly initialized
    Event event;
    event.isAvailable = false ; event.isIdentical = false ; event.isCompressed = false ;
    event.RunNumber = evtStreamID.RunNumber();
    event.EventNumber=evtStreamID.EventNumber();
    event.StreamName=strdup(evtStreamID.StreamName().c_str());
    event.NBytes = strlen(eventStr.c_str())+1;
    event.EventData = strdup(eventStr.c_str());
 
    ATH_MSG_VERBOSE( "Created event structure for event " << event.EventNumber 
                     << " from run " << event.RunNumber 
                     << " to be put in stream " << event.StreamName 
                     << " with " << event.NBytes << " bytes"  );
 
    //Try to get a client
    if (GetClient().isFailure()) {
      ATH_MSG_WARNING( "Failed obtaining a client for sever on host " << m_hostName  );
      ATH_MSG_WARNING( " while updating stream " << evtStreamID.StreamName()
                       << " with event " << evtStreamID.EventNumber() 
                       << " from run " << evtStreamID.RunNumber()  );
      //delete char * strings malloc'ed by strdup
      //are checkers enabled here?
      auto *p1 = const_cast<char*>(event.StreamName);
      auto *p2 = const_cast<char*>(event.EventData);
      free(p1);
      free(p2);
      return StatusCode::FAILURE;
    }
 
    //Call the client to update the event
    bool isSuccess = false;
    clnt_stat ret = clnt_call(m_client, ONCRPC_SETEVENT_PROC, (xdrproc_t)xdr_event, (caddr_t)&event,
                             (xdrproc_t)xdr_bool,(caddr_t)&isSuccess, GetTimeout());
 
    //And check for the result
    if (ret != RPC_SUCCESS){
      ATH_MSG_WARNING( "Failed calling the server on host " << m_hostName << " : " << clnt_sperrno(ret)  );
      ATH_MSG_WARNING( " while updating stream " << evtStreamID.StreamName()
                       << " with event " << evtStreamID.EventNumber() 
                       << " from run " << evtStreamID.RunNumber()  );
      return StatusCode::FAILURE;
    } 
 
    //Check if the server managed to update the event from return value
    if (!isSuccess){
      ATH_MSG_WARNING( "Server on host " << m_hostName << " returned failure "  );
      ATH_MSG_WARNING( " while updating stream " << evtStreamID.StreamName()
                       << " with event " << evtStreamID.EventNumber() 
                       << " from run " << evtStreamID.RunNumber()  );
      return StatusCode::FAILURE;
    } 
 
    //Be verbose on success
    ATH_MSG_DEBUG( "Server on host " << m_hostName << " returned success " );
    ATH_MSG_DEBUG( " while updating stream " << evtStreamID.StreamName()
                   << " with event " << evtStreamID.EventNumber() 
                   << " from run " << evtStreamID.RunNumber()  );
 
    //Finally free the memory allocated for the event structure
    xdr_free((xdrproc_t)xdr_event,(caddr_t)&event);
 
    return StatusCode::SUCCESS;
  }

Member Data Documentation

m_client

CLIENT* JiveXML::ExternalONCRPCServerSvc::m_client

private

Definition at line 59 of file ExternalONCRPCServerSvc.h.

m_hostName

std::string JiveXML::ExternalONCRPCServerSvc::m_hostName

private

Definition at line 53 of file ExternalONCRPCServerSvc.h.

m_timeOut

double JiveXML::ExternalONCRPCServerSvc::m_timeOut

private

Definition at line 56 of file ExternalONCRPCServerSvc.h.

---

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

• ExternalONCRPCServerSvc.h
• ExternalONCRPCServerSvc.cxx