xrootd
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
XrdOucERoute Class Reference

#include <XrdOucERoute.hh>

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)
 
static int Route (XrdSysError *elog, XrdOucStream *estrm, const char *esfx, int ecode, const char *etxt1, const char *etxt2=0)
 

Constructor & Destructor Documentation

◆ XrdOucERoute()

XrdOucERoute::XrdOucERoute ( )
inline

◆ ~XrdOucERoute()

XrdOucERoute::~XrdOucERoute ( )
inline

Member Function Documentation

◆ Format()

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

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

Parameters
buffpointer to the buffer where the msg is to be placed.
blenthe length of the buffer.
ecodethe error number associated iwth the error.
etxt1associated text token #1.
etxt2associated text token #2 (optional).
Returns
<int> The number of characters placed in the buffer less null.

◆ Route()

static 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
elogpointer to the XrdSysError object to use to route the message to the log, If null, the message isn't routed there.
estrmpointer to the XrdOucStrean object which is to receive the error message text or null if none exists.
esfxThe suffix identifier to use when routing to the log.
ecodethe error number associated iwth the error.
etxt1associated text token #1.
etxt2associated text token #2 (optional).
Returns
<int> The -abs(enum) or -1 if enum is zero.

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