XrdSsiErrInfo Class Reference

#include <XrdSsiErrInfo.hh>

List of all members.

Public Member Functions

void Clr ()
 Reset and clear error information.
const std::string & Get (int &eNum) const
const std::string & Get () const
int GetArg () const
bool hasError () const
bool isOK () const
void Set (const char *eMsg=0, int eNum=0, int eArg=0)
void Set (const std::string &eMsg, int eNum=0, int eArg=0)
XrdSsiErrInfooperator= (XrdSsiErrInfo const &rhs)
 Assignment operator.
 XrdSsiErrInfo (XrdSsiErrInfo const &oP)
 Copy constructor.
 XrdSsiErrInfo ()
 Constructor and Destructor.
 ~XrdSsiErrInfo ()

Private Attributes

std::string errText
int errNum
int errArg

Detailed Description

The XrdSsiErrInfo object is used to hold error information for many ssi client-oriented requests.


Constructor & Destructor Documentation

XrdSsiErrInfo::XrdSsiErrInfo ( XrdSsiErrInfo const &  oP  )  [inline]

Copy constructor.

References errArg, errNum, errText, and Set().

XrdSsiErrInfo::XrdSsiErrInfo (  )  [inline]

Constructor and Destructor.

XrdSsiErrInfo::~XrdSsiErrInfo (  )  [inline]

Member Function Documentation

void XrdSsiErrInfo::Clr (  )  [inline]

Reset and clear error information.

References errArg, errNum, and errText.

const std::string& XrdSsiErrInfo::Get (  )  const [inline]

Get current error text.

Returns:
The error text.

References errText.

const std::string& XrdSsiErrInfo::Get ( int &  eNum  )  const [inline]

Get current error information.

Parameters:
eNum place where the error number is to be placed.
Returns:
The error text and the error number value.

References errNum, and errText.

int XrdSsiErrInfo::GetArg (  )  const [inline]

Get current error argument.

Returns:
the error argument value.

References errArg.

bool XrdSsiErrInfo::hasError (  )  const [inline]

Check if there is an error.

Returns:
True if an error exists and false otherwise.

References errNum.

bool XrdSsiErrInfo::isOK (  )  const [inline]

Check if there is no error.

Returns:
True if no error exists and false otherwise.

References errNum.

XrdSsiErrInfo& XrdSsiErrInfo::operator= ( XrdSsiErrInfo const &  rhs  )  [inline]

Assignment operator.

References errArg, errNum, errText, and Set().

void XrdSsiErrInfo::Set ( const std::string &  eMsg,
int  eNum = 0,
int  eArg = 0 
) [inline]

References errArg, errNum, and errText.

void XrdSsiErrInfo::Set ( const char *  eMsg = 0,
int  eNum = 0,
int  eArg = 0 
) [inline]

Set new error information. There are two obvious variations.

Parameters:
eMsg pointer to a string describing the error. If nil, the eNum is taken as errno and strerror(eNum) is used.
eNum the error number associated with the error.
eArg the error argument, if any (see XrdSsiService::Provision()).

References errArg, errNum, and errText.

Referenced by XrdSsiStream::GetBuff(), XrdSsiProvider::GetService(), operator=(), XrdSsiStream::SetBuff(), and XrdSsiErrInfo().


Member Data Documentation

int XrdSsiErrInfo::errArg [private]
int XrdSsiErrInfo::errNum [private]
std::string XrdSsiErrInfo::errText [private]

Referenced by Clr(), Get(), operator=(), Set(), and XrdSsiErrInfo().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 5 Feb 2020 for xrootd by  doxygen 1.6.1