#include <XrdOucERoute.hh>

Collaboration diagram for XrdOucERoute:

Public Member Functions
	XrdOucERoute ()
	~XrdOucERoute ()

Static Public Member Functions
static int	Format (char buff, int blen, int ecode, const char etxt1, const char etxt2=0, const char xtra=0)
static int	Route (XrdSysError elog, XrdOucStream estrm, const char esfx, int ecode, const char etxt1, const char *etxt2=0)

Detailed Description

Definition at line 36 of file XrdOucERoute.hh.

Constructor & Destructor Documentation

◆ XrdOucERoute()

XrdOucERoute::XrdOucERoute ( )

inline

Definition at line 76 of file XrdOucERoute.hh.

76{}

◆ ~XrdOucERoute()

XrdOucERoute::~XrdOucERoute ( )

inline

Definition at line 78 of file XrdOucERoute.hh.

78{}

Member Function Documentation

◆ Format()

int XrdOucERoute::Format	(	char *	buff,
		int	blen,
		int	ecode,
		const char *	etxt1,
		const char *	etxt2 = 0,
		const char *	xtra = 0 )

static

Format an error message into a buffer in the form of: "Unable to <etxt1> <etxt2>; <syserror[enum]>"

Parameters

buff	pointer to the buffer where the msg is to be placed.
blen	the length of the buffer.
ecode	the error number associated iwth the error.
etxt1	associated text token #1.
etxt2	associated text token #2 (optional).
xtra	Optional additional text to include on the next line

Returns: <int> The number of characters placed in the buffer less null.

Definition at line 44 of file XrdOucERoute.cc.

{
   const char *esep = " ", *estr = XrdSysError::ec2text(ecode);
   const char *xsep = "";
   char ebuff[256];
   int n;
 
// Substitute something of no ecode translation exists
//
   if (!estr) estr = "reason unknown";
      else if (isupper(static_cast<int>(*estr)))
              {strlcpy(ebuff, estr, sizeof(ebuff));
               *ebuff = static_cast<char>(tolower(static_cast<int>(*estr)));
               estr = ebuff;
              }
 
// Set format elements
//
   if (!etxt2) etxt2 = esep = "";
   if (xtra) xsep = "\nAdditional context: ";
      else   xtra = "";
 
// Format the message
//
   n = snprintf(buff, blen, "Unable to %s%s%s; %s%s%s",etxt1,esep,etxt2,estr,
                                                       xsep, xtra);
   return (n < blen ? n : blen-1);
}

References XrdSysError::ec2text(), and strlcpy().

Referenced by XrdOfs::Emsg(), XrdSsiUtils::Emsg(), and Route().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Route()

int XrdOucERoute::Route	(	XrdSysError *	elog,
		XrdOucStream *	estrm,
		const char *	esfx,
		int	ecode,
		const char *	etxt1,
		const char *	etxt2 = 0 )

static

Format an error message using Format() and route it as requested.

Parameters

elog	pointer to the XrdSysError object to use to route the message to the log, If null, the message isn't routed there.
estrm	pointer to the XrdOucStrean object which is to receive the error message text or null if none exists.
esfx	The suffix identifier to use when routing to the log.
ecode	the error number associated iwth the error.
etxt1	associated text token #1.
etxt2	associated text token #2 (optional).

Returns: <int> The -abs(enum) or -1 if enum is zero.

Definition at line 79 of file XrdOucERoute.cc.

{
   char ebuff[2048];
   int elen;
 
// Format the error message
//
   elen = Format(ebuff, sizeof(ebuff), ecode, etxt1, etxt2);
 
// Route appropriately
//
   if (elog)  elog->Emsg(esfx, ebuff);
   if (estrm) estrm->Put(ebuff, elen);
 
// Return the error number
//
   if (ecode) return (ecode < 0 ? ecode : -ecode);
   return -1;
}

References XrdSysError::Emsg(), Format(), and XrdOucStream::Put().