#include <XrdOucErrInfo.hh>
|
void | clear () |
| Reset data and error information to null. Any appenadges are released. More...
|
|
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. More...
|
|
int | getUCap () |
|
void | setUCap (int ucval) |
| Set user capabilties. More...
|
|
XrdOucErrInfo & | operator= (const XrdOucErrInfo &rhs) |
| Assignment operator. More...
|
|
| 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. More...
|
|
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
- Parameters
-
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
- Parameters
-
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
- Parameters
-
user | - Pointer to he user string in stable storage. |
MonID | - The monitoring identifier. |
uc | - The user capabilities. |
virtual XrdOucErrInfo::~XrdOucErrInfo |
( |
| ) |
|
|
inlinevirtual |
void XrdOucErrInfo::clear |
( |
| ) |
|
|
inline |
Reset data and error information to null. Any appenadges are released.
bool XrdOucErrInfo::extData |
( |
| ) |
|
|
inline |
Check if this object will return extended data (can optimize Reset() calls).
- Returns
- true - there is extended data. false - there is no extended data.
Get a pointer to the error environment that was previously set.
- Returns
- =0 - A callback is in effect which is mutually exclusive of conaining an error environment (i.e. no environment).
-
!0 - Pointer to the error environment.
unsigned long long XrdOucErrInfo::getErrArg |
( |
| ) |
|
|
inline |
Obtain the callback argument.
- Returns
- The argument value currently in effect.
XrdOucEICB* XrdOucErrInfo::getErrCB |
( |
unsigned long long & |
ap | ) |
|
|
inline |
Get the callback object and its argument.
- Parameters
-
ap | - Reference to where the callback argument is returned. |
- Returns
- Pointer to the callback object, ap holds the argument.
const char* XrdOucErrInfo::getErrData |
( |
| ) |
|
|
inline |
Get the error tracing data.
- Returns
- =0 - No tracing data has been set.
-
!0 - Pointer to error tracing data.
int XrdOucErrInfo::getErrInfo |
( |
| ) |
|
|
inline |
Get the error code.
- Returns
- The error code that was previously set.
int XrdOucErrInfo::getErrMid |
( |
| ) |
|
|
inline |
Get the monitoring identifier.
- Returns
- The monitoring identifier.
const char* XrdOucErrInfo::getErrText |
( |
| ) |
|
|
inline |
Get a pointer to the error text.
- Returns
- The pointer to the internal error text.
const char* XrdOucErrInfo::getErrText |
( |
int & |
ecode | ) |
|
|
inline |
Get a pointer to the error text and the error code.
- Parameters
-
ecode | - Reference to where the error code is to be returned. |
- Returns
- The pointer to the internal error text.
int XrdOucErrInfo::getErrTextLen |
( |
| ) |
|
|
inline |
Get the error text length (optimized for external buffers).
- Returns
- The mesage length.
const char* XrdOucErrInfo::getErrUser |
( |
| ) |
|
|
inline |
Get a pointer to user information.
- Returns
- The pointer to the user string.
char* XrdOucErrInfo::getMsgBuff |
( |
int & |
mblen | ) |
|
|
inline |
Get the pointer to the internal message buffer along with its size.
- Parameters
-
mblen | - Reference to where the size it to be returned. |
- Returns
- Pointer to the internal message buffer.
int XrdOucErrInfo::getUCap |
( |
| ) |
|
|
inline |
Get user capabilties.
- Returns
- the user capabilities.
void XrdOucErrInfo::Reset |
( |
| ) |
|
|
inline |
Reset object to no message state. Call this method to release appendages.
Set the error environment and return the previous environment. This call destroys any callback information that may have existed.
- Parameters
-
newEnv | - Pointer to the new error environment. |
- Returns
- =0 - No previous envuironment existed.
-
!0 - Pointer to the previous error environment.
void XrdOucErrInfo::setErrArg |
( |
unsigned long long |
cbarg = 0 | ) |
|
|
inline |
Set callback argument.
- Parameters
-
cbarg | - An opaque 8-byte call-back argument. |
void XrdOucErrInfo::setErrCB |
( |
XrdOucEICB * |
cb, |
|
|
unsigned long long |
cbarg = 0 |
|
) |
| |
|
inline |
Set callback information.
- Parameters
-
cb | - Pointer to the object describing the callback. |
cbarg | - An opaque 8-byte call-back argument. |
int XrdOucErrInfo::setErrCode |
( |
int |
code | ) |
|
|
inline |
Set error code. Any existing error text remains intact.
- Parameters
-
code | - The error number describing the error. |
- Returns
- code - The error number.
References XrdOucEI::code.
void XrdOucErrInfo::setErrData |
( |
const char * |
Data, |
|
|
int |
Offs = 0 |
|
) |
| |
|
inline |
Set the error tracing data (this is always placed in the internal buffer)
- Parameters
-
Data | - Pointer to the error tracing data. |
Offs | - Ofset into the message buffer where the data is to be set. |
References strlcpy().
int XrdOucErrInfo::setErrInfo |
( |
int |
code, |
|
|
const char * |
emsg |
|
) |
| |
|
inline |
Set error code and error text.
- Parameters
-
code | - The error number describing the error. |
emsg | - The error message text. |
- Returns
- code - The error number.
References XrdOucEI::code, and strlcpy().
int XrdOucErrInfo::setErrInfo |
( |
int |
code, |
|
|
const char * |
txtlist[], |
|
|
int |
n |
|
) |
| |
|
inline |
Set error code and error text.
- Parameters
-
code | - The error number describing the error. |
txtlist | - A vector of error message text segments. |
n | - The number of valid elements in txtlist. |
- Returns
- code - The error number.
References XrdOucEI::code, and strlcpy().
int XrdOucErrInfo::setErrInfo |
( |
int |
code, |
|
|
XrdOucBuffer * |
buffP |
|
) |
| |
|
inline |
Set error code and error text.
- Parameters
-
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. |
- Returns
- code - The error number.
References XrdOucEI::code.
void XrdOucErrInfo::setErrMid |
( |
int |
mid | ) |
|
|
inline |
Set the monitoring identifier.
- Returns
- The monitoring identifier.
void XrdOucErrInfo::setErrUser |
( |
const char * |
user | ) |
|
|
inline |
Set user pointer.
- Parameters
-
user | - Pointer to a stable storage area containing the username. |
void XrdOucErrInfo::setUCap |
( |
int |
ucval | ) |
|
|
inline |
XrdOucBuffer* XrdOucErrInfo::dataBuff |
|
protected |
short XrdOucErrInfo::dOff |
|
protected |
unsigned long long XrdOucErrInfo::ErrCBarg |
short XrdOucErrInfo::reserved |
|
protected |
The documentation for this class was generated from the following file: