#include <XrdOucErrInfo.hh>
Public Member Functions | |
void | clear () |
Reset data and error information to null. Any appenadges are released. | |
void | setErrArg (unsigned long long cbarg=0) |
void | setErrCB (XrdOucEICB *cb, unsigned long long cbarg=0) |
int | setErrCode (int code) |
int | setErrInfo (int code, const char *emsg) |
int | setErrInfo (int code, const char *txtlist[], int n) |
int | setErrInfo (int code, XrdOucBuffer *buffP) |
void | setErrUser (const char *user) |
unsigned long long | getErrArg () |
char * | getMsgBuff (int &mblen) |
XrdOucEICB * | getErrCB () |
XrdOucEICB * | getErrCB (unsigned long long &ap) |
int | getErrInfo () |
const char * | getErrText () |
const char * | getErrText (int &ecode) |
int | getErrTextLen () |
const char * | getErrUser () |
XrdOucEnv * | getEnv () |
XrdOucEnv * | setEnv (XrdOucEnv *newEnv) |
const char * | getErrData () |
void | setErrData (const char *Data, int Offs=0) |
int | getErrMid () |
void | setErrMid (int mid) |
bool | extData () |
void | Reset () |
Reset object to no message state. Call this method to release appendages. | |
int | getUCap () |
void | setUCap (int ucval) |
Set user capabilties. | |
XrdOucErrInfo & | operator= (const XrdOucErrInfo &rhs) |
Assignment operator. | |
XrdOucErrInfo (const char *user=0, XrdOucEICB *cb=0, unsigned long long ca=0, int mid=0, int uc=0) | |
XrdOucErrInfo (const char *user, XrdOucEnv *envp, int uc=0) | |
XrdOucErrInfo (const char *user, int MonID, int uc=0) | |
virtual | ~XrdOucErrInfo () |
Destructor. | |
Protected Attributes | |
XrdOucEI | ErrInfo |
XrdOucEICB * | ErrCB |
union { | |
unsigned long long ErrCBarg | |
XrdOucEnv * ErrEnv | |
}; | |
int | mID |
short | dOff |
short | reserved |
XrdOucBuffer * | dataBuff |
The XrdOucErrInfo class is used to communicate data, error, and callback information between plug-ins.
XrdOucErrInfo::XrdOucErrInfo | ( | const char * | user = 0 , |
|
XrdOucEICB * | cb = 0 , |
|||
unsigned long long | ca = 0 , |
|||
int | mid = 0 , |
|||
int | uc = 0 | |||
) | [inline] |
Constructor
user | - Pointer to he user string in stable storage. | |
cb | - Pointer to the callback object (zero if none). | |
ca | - The callback argument. | |
mid | - The monitoring identifier. | |
uc | - The user capabilities. |
XrdOucErrInfo::XrdOucErrInfo | ( | const char * | user, | |
XrdOucEnv * | envp, | |||
int | uc = 0 | |||
) | [inline] |
Constructor
user | - Pointer to he user string in stable storage. | |
envp | - Pointer to the error environment. | |
uc | - The user capabilities. |
XrdOucErrInfo::XrdOucErrInfo | ( | const char * | user, | |
int | MonID, | |||
int | uc = 0 | |||
) | [inline] |
Constructor
user | - Pointer to he user string in stable storage. | |
MonID | - The monitoring identifier. | |
uc | - The user capabilities. |
virtual XrdOucErrInfo::~XrdOucErrInfo | ( | ) | [inline, virtual] |
Destructor.
References Reset().
void XrdOucErrInfo::clear | ( | ) | [inline] |
Reset data and error information to null. Any appenadges are released.
References XrdOucEI::clear(), ErrInfo, and Reset().
bool XrdOucErrInfo::extData | ( | ) | [inline] |
XrdOucEnv* XrdOucErrInfo::getEnv | ( | ) | [inline] |
unsigned long long XrdOucErrInfo::getErrArg | ( | ) | [inline] |
XrdOucEICB* XrdOucErrInfo::getErrCB | ( | unsigned long long & | ap | ) | [inline] |
XrdOucEICB* XrdOucErrInfo::getErrCB | ( | ) | [inline] |
Get the callback object.
References ErrCB.
Referenced by XrdOucCallBack::Allowed(), and XrdOfsEvr::theClient::theClient().
const char* XrdOucErrInfo::getErrData | ( | ) | [inline] |
Get the error tracing data.
References dOff, ErrInfo, and XrdOucEI::message.
int XrdOucErrInfo::getErrInfo | ( | ) | [inline] |
Get the error code.
References XrdOucEI::code, and ErrInfo.
int XrdOucErrInfo::getErrMid | ( | ) | [inline] |
const char* XrdOucErrInfo::getErrText | ( | int & | ecode | ) | [inline] |
Get a pointer to the error text and the error code.
ecode | - Reference to where the error code is to be returned. |
References XrdOucEI::code, XrdOucBuffer::Data(), dataBuff, ErrInfo, and XrdOucEI::message.
const char* XrdOucErrInfo::getErrText | ( | ) | [inline] |
Get a pointer to the error text.
References XrdOucBuffer::Data(), dataBuff, ErrInfo, and XrdOucEI::message.
int XrdOucErrInfo::getErrTextLen | ( | ) | [inline] |
Get the error text length (optimized for external buffers).
References dataBuff, XrdOucBuffer::DataLen(), ErrInfo, and XrdOucEI::message.
const char* XrdOucErrInfo::getErrUser | ( | ) | [inline] |
Get a pointer to user information.
References ErrInfo, and XrdOucEI::user.
Referenced by XrdOfs::newDir(), XrdOfs::newFile(), and XrdOfsEvr::theClient::theClient().
char* XrdOucErrInfo::getMsgBuff | ( | int & | mblen | ) | [inline] |
Get the pointer to the internal message buffer along with its size.
mblen | - Reference to where the size it to be returned. |
References ErrInfo, and XrdOucEI::message.
int XrdOucErrInfo::getUCap | ( | ) | [inline] |
XrdOucErrInfo& XrdOucErrInfo::operator= | ( | const XrdOucErrInfo & | rhs | ) | [inline] |
void XrdOucErrInfo::Reset | ( | ) | [inline] |
Reset object to no message state. Call this method to release appendages.
References XrdOucEI::code, dataBuff, ErrInfo, XrdOucEI::message, and XrdOucBuffer::Recycle().
Referenced by clear(), and ~XrdOucErrInfo().
Set the error environment and return the previous environment. This call destroys any callback information that may have existed.
newEnv | - Pointer to the new error environment. |
void XrdOucErrInfo::setErrArg | ( | unsigned long long | cbarg = 0 |
) | [inline] |
Set callback argument.
cbarg | - An opaque 8-byte call-back argument. |
References ErrCBarg.
void XrdOucErrInfo::setErrCB | ( | XrdOucEICB * | cb, | |
unsigned long long | cbarg = 0 | |||
) | [inline] |
int XrdOucErrInfo::setErrCode | ( | int | code | ) | [inline] |
Set error code. Any existing error text remains intact.
code | - The error number describing the error. |
References XrdOucEI::code, and ErrInfo.
void XrdOucErrInfo::setErrData | ( | const char * | Data, | |
int | Offs = 0 | |||
) | [inline] |
Set the error tracing data (this is always placed in the internal buffer)
Data | - Pointer to the error tracing data. | |
Offs | - Ofset into the message buffer where the data is to be set. |
References dOff, ErrInfo, XrdOucEI::message, and strlcpy().
int XrdOucErrInfo::setErrInfo | ( | int | code, | |
XrdOucBuffer * | buffP | |||
) | [inline] |
Set error code and error text.
code | - The error number describing the error. | |
buffP | - Pointer to the data buffer holding the error text, This object takes ownership of the buffer and recycles it. |
References XrdOucEI::code, dataBuff, ErrInfo, and XrdOucBuffer::Recycle().
int XrdOucErrInfo::setErrInfo | ( | int | code, | |
const char * | txtlist[], | |||
int | n | |||
) | [inline] |
Set error code and error text.
code | - The error number describing the error. | |
txtlist | - A vector of error message text segments. | |
n | - The number of valid elements in txtlist. |
References XrdOucEI::code, dataBuff, ErrInfo, XrdOucEI::message, XrdOucBuffer::Recycle(), and strlcpy().
int XrdOucErrInfo::setErrInfo | ( | int | code, | |
const char * | emsg | |||
) | [inline] |
Set error code and error text.
code | - The error number describing the error. | |
emsg | - The error message text. |
References XrdOucEI::code, dataBuff, ErrInfo, XrdOucEI::message, XrdOucBuffer::Recycle(), and strlcpy().
void XrdOucErrInfo::setErrMid | ( | int | mid | ) | [inline] |
void XrdOucErrInfo::setErrUser | ( | const char * | user | ) | [inline] |
Set user pointer.
user | - Pointer to a stable storage area containing the username. |
References ErrInfo, and XrdOucEI::user.
void XrdOucErrInfo::setUCap | ( | int | ucval | ) | [inline] |
Set user capabilties.
References ErrInfo, and XrdOucEI::ucap.
union { ... } [protected] |
XrdOucBuffer* XrdOucErrInfo::dataBuff [protected] |
Referenced by extData(), getErrText(), getErrTextLen(), operator=(), Reset(), and setErrInfo().
short XrdOucErrInfo::dOff [protected] |
Referenced by getErrData(), operator=(), and setErrData().
XrdOucEICB* XrdOucErrInfo::ErrCB [protected] |
Referenced by getEnv(), getErrCB(), operator=(), setEnv(), and setErrCB().
unsigned long long XrdOucErrInfo::ErrCBarg |
Referenced by getErrArg(), getErrCB(), operator=(), setErrArg(), and setErrCB().
XrdOucEI XrdOucErrInfo::ErrInfo [protected] |
Referenced by clear(), getErrData(), getErrInfo(), getErrText(), getErrTextLen(), getErrUser(), getMsgBuff(), getUCap(), operator=(), Reset(), setErrCode(), setErrData(), setErrInfo(), setErrUser(), and setUCap().
int XrdOucErrInfo::mID [protected] |
Referenced by getErrMid(), operator=(), and setErrMid().
short XrdOucErrInfo::reserved [protected] |