![]() |
XRootD
|
#include <XrdOucErrInfo.hh>
Public Member Functions | |
XrdOucErrInfo (const char *user, int MonID, int uc=0) | |
XrdOucErrInfo (const char *user, XrdOucEnv *envp, int uc=0) | |
XrdOucErrInfo (const char *user=0, XrdOucEICB *cb=0, unsigned long long ca=0, int mid=0, int uc=0) | |
virtual | ~XrdOucErrInfo () |
Destructor. More... | |
void | clear () |
Reset data and error information to null. Any appenadges are released. More... | |
bool | extData () |
XrdOucEnv * | getEnv () |
unsigned long long | getErrArg () |
XrdOucEICB * | getErrCB () |
XrdOucEICB * | getErrCB (unsigned long long &ap) |
const char * | getErrData () |
int | getErrInfo () |
int | getErrMid () |
const char * | getErrText () |
const char * | getErrText (int &ecode) |
int | getErrTextLen () |
const char * | getErrUser () |
char * | getMsgBuff (int &mblen) |
int | getUCap () |
XrdOucErrInfo & | operator= (const XrdOucErrInfo &rhs) |
Assignment operator. More... | |
void | Reset () |
Reset object to no message state. Call this method to release appendages. More... | |
XrdOucEnv * | setEnv (XrdOucEnv *newEnv) |
void | setErrArg (unsigned long long cbarg=0) |
void | setErrCB (XrdOucEICB *cb, unsigned long long cbarg=0) |
int | setErrCode (int code) |
void | setErrData (const char *Data, int Offs=0) |
int | setErrInfo (int code, const char *emsg) |
int | setErrInfo (int code, const char *txtlist[], int n) |
int | setErrInfo (int code, XrdOucBuffer *buffP) |
void | setErrMid (int mid) |
Set the monitoring identifier. More... | |
void | setErrUser (const char *user) |
void | setUCap (int ucval) |
Set user capabilties. More... | |
Protected Attributes | |
union { | |
unsigned long long | ErrCBarg |
XrdOucEnv * | ErrEnv |
}; | |
XrdOucBuffer * | dataBuff |
short | dOff |
XrdOucEICB * | ErrCB |
XrdOucEI | ErrInfo |
int | mID |
short | reserved |
The XrdOucErrInfo class is used to communicate data, error, and callback information between plug-ins.
Definition at line 100 of file XrdOucErrInfo.hh.
|
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. |
Definition at line 422 of file XrdOucErrInfo.hh.
|
inline |
|
inline |
|
inlinevirtual |
Destructor.
Definition at line 455 of file XrdOucErrInfo.hh.
References Reset().
|
inline |
Reset data and error information to null. Any appenadges are released.
Definition at line 108 of file XrdOucErrInfo.hh.
References XrdOucEI::clear(), ErrInfo, and Reset().
Referenced by XrdOfsDirectory::nextEntry(), and XrdSfsNativeDirectory::nextEntry().
|
inline |
Check if this object will return extended data (can optimize Reset() calls).
Definition at line 371 of file XrdOucErrInfo.hh.
References dataBuff.
Referenced by XrdXrootdAioTask::SendFSError(), XrdXrootdCallBack::sendResp(), and XrdXrootdCallBack::sendVesp().
|
inline |
Get a pointer to the error environment that was previously set.
Definition at line 307 of file XrdOucErrInfo.hh.
References ErrCB.
Referenced by XrdOfs::chksum(), XrdOfs::FAttr(), XrdSecPManager::Get(), XrdSecProtocolgsi::getCredentials(), XrdSecProtocolkrb5::getCredentials(), XrdSecProtocolsss::getCredentials(), and XrdSecProtocolsss::Load_Client().
|
inline |
Obtain the callback argument.
Definition at line 203 of file XrdOucErrInfo.hh.
Referenced by XrdXrootdCallBack::sendResp(), and XrdXrootdCallBack::sendVesp().
|
inline |
Get the callback object.
Definition at line 224 of file XrdOucErrInfo.hh.
References ErrCB.
Referenced by XrdOfsEvr::theClient::theClient(), XrdBwmHandle::Activate(), XrdCmsResp::Alloc(), XrdOucCallBack::Allowed(), XrdXrootdCBJob::DoIt(), XrdXrootdCallBack::Done(), XrdOucCallBack::Init(), and XrdSsiFileReq::WantResponse().
|
inline |
Get the callback object and its argument.
ap | - Reference to where the callback argument is returned. |
Definition at line 234 of file XrdOucErrInfo.hh.
References ErrCB.
|
inline |
Get the error tracing data.
Definition at line 333 of file XrdOucErrInfo.hh.
References dOff, ErrInfo, and XrdOucEI::message.
Referenced by XrdCmsResp::Alloc(), and XrdCmsParser::Decode().
|
inline |
Get the error code.
Definition at line 243 of file XrdOucErrInfo.hh.
References XrdOucEI::code, and ErrInfo.
Referenced by XrdSecsssKT::XrdSecsssKT(), XrdXrootdFile::XrdXrootdFile(), XrdXrootdProtocol::Configure(), XrdCmsClientMan::delayResp(), XrdSecPManager::Get(), XrdSecProtocolsss::Init_Client(), XrdSecProtocolsss::Load_Client(), XrdSecProtocolsss::Load_Server(), XrdCmsRedirLocal::Locate(), main(), XrdPssFile::Open(), XrdSecsssKT::Refresh(), XrdOfs::rename(), XrdSecsssAdmin_addKey(), XrdSecsssAdmin_delKey(), XrdSecsssAdmin_insKey(), and XrdSecsssAdmin_lstKey().
|
inline |
Get the monitoring identifier.
Definition at line 356 of file XrdOucErrInfo.hh.
References mID.
Referenced by XrdCmsResp::Alloc(), and XrdXrootdCallBack::sendError().
|
inline |
Get a pointer to the error text.
Definition at line 262 of file XrdOucErrInfo.hh.
References XrdOucBuffer::Data(), dataBuff, ErrInfo, and XrdOucEI::message.
Referenced by XrdXrootdCBJob::DoIt(), XrdSecPManager::Get(), XrdSecProtocolgsi::Init(), XrdCmsRedirLocal::Locate(), main(), XrdSecServer::PostProcess(), XrdSecTLayer::secXeq(), XrdXrootdCallBack::sendError(), and XrdXrootdAioTask::SendFSError().
|
inline |
Get a pointer to the error text and the error code.
ecode | - Reference to where the error code is to be returned. |
Definition at line 274 of file XrdOucErrInfo.hh.
References XrdOucEI::code, XrdOucBuffer::Data(), dataBuff, ErrInfo, and XrdOucEI::message.
|
inline |
Get the error text length (optimized for external buffers).
Definition at line 286 of file XrdOucErrInfo.hh.
References dataBuff, XrdOucBuffer::DataLen(), ErrInfo, and XrdOucEI::message.
Referenced by XrdXrootdCBJob::DoIt(), and XrdXrootdCallBack::sendError().
|
inline |
Get a pointer to user information.
Definition at line 297 of file XrdOucErrInfo.hh.
References ErrInfo, and XrdOucEI::user.
Referenced by XrdOfsEvr::theClient::theClient(), XrdCmsResp::Alloc(), XrdOfsTPC::Authorize(), XrdOfs::chksum(), XrdOfs::chmod(), XrdCmsParser::Decode(), XrdCmsClientMan::delayResp(), XrdXrootdCBJob::DoIt(), XrdXrootdCallBack::Done(), XrdBwm::Emsg(), XrdOfs::Emsg(), XrdOfs::exists(), XrdOfsTPC::Fatal(), XrdOfs::FAttr(), XrdCmsFinderRMT::Forward(), XrdSsiSfs::fsctl(), XrdOfs::fsctl(), XrdOucCallBack::Init(), XrdCmsFinderRMT::Locate(), XrdOfs::mkdir(), XrdOfs::newDir(), XrdOfs::newFile(), XrdBwmFile::open(), XrdCmsFinderRMT::Prepare(), XrdOfs::rename(), XrdXrootdCallBack::sendError(), XrdXrootdCallBack::sendResp(), XrdXrootdCallBack::sendVesp(), XrdCmsFinderRMT::Space(), XrdBwm::Stall(), XrdOfs::stat(), and XrdOfs::truncate().
|
inline |
Get the pointer to the internal message buffer along with its size.
mblen | - Reference to where the size it to be returned. |
Definition at line 213 of file XrdOucErrInfo.hh.
References ErrInfo, and XrdOucEI::message.
Referenced by XrdBwmHandle::Activate(), XrdSsiFileSess::AttnInfo(), XrdOfsPrepGPIReal::PrepGPI::cancel(), XrdBwmHandle::Dispatch(), XrdOfs::fsctl(), XrdCmsFinderTRG::Locate(), XrdOfsPrepGPIReal::PrepGPI::query(), and XrdSsiAlert::SetInfo().
|
inline |
Get user capabilties.
Definition at line 389 of file XrdOucErrInfo.hh.
References ErrInfo, and XrdOucEI::ucap.
Referenced by XrdSsiSfs::fsctl(), XrdOfs::fsctl(), XrdDigConfig::GetLocResp(), XrdCmsRedirLocal::Locate(), XrdCmsFinderRMT::Locate(), and XrdOfsFile::open().
|
inline |
Assignment operator.
Definition at line 401 of file XrdOucErrInfo.hh.
References XrdOucBuffer::Clone(), dataBuff, dOff, ErrCB, ErrInfo, and mID.
|
inline |
Reset object to no message state. Call this method to release appendages.
Definition at line 377 of file XrdOucErrInfo.hh.
References XrdOucEI::code, dataBuff, ErrInfo, XrdOucEI::message, and XrdOucBuffer::Recycle().
Referenced by ~XrdOucErrInfo(), clear(), XrdXrootdAioTask::SendFSError(), XrdXrootdCallBack::sendResp(), and XrdXrootdCallBack::sendVesp().
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. |
Definition at line 319 of file XrdOucErrInfo.hh.
References ErrCB.
|
inline |
Set callback argument.
cbarg | - An opaque 8-byte call-back argument. |
Definition at line 116 of file XrdOucErrInfo.hh.
|
inline |
Set callback information.
cb | - Pointer to the object describing the callback. |
cbarg | - An opaque 8-byte call-back argument. |
Definition at line 125 of file XrdOucErrInfo.hh.
References ErrCB.
Referenced by XrdBwmHandle::Activate(), XrdCmsResp::Alloc(), XrdBwmHandle::Dispatch(), XrdOucCallBack::Init(), XrdOfsEvr::Wait4Event(), and XrdSsiFileReq::WantResponse().
|
inline |
Set error code. Any existing error text remains intact.
code | - The error number describing the error. |
Definition at line 136 of file XrdOucErrInfo.hh.
References XrdOucEI::code, and ErrInfo.
Referenced by XrdSecsssKT::XrdSecsssKT(), XrdBwmHandle::Activate(), XrdSsiFileSess::AttnInfo(), XrdOfsPrepGPIReal::PrepGPI::cancel(), XrdOfs::chksum(), XrdBwmHandle::Dispatch(), XrdDigFile::fctl(), XrdOfsFile::fctl(), XrdSfsNativeFile::fctl(), XrdSsiFile::fctl(), XrdOfs::fsctl(), XrdCmsFinderTRG::Locate(), XrdOfsPrepGPIReal::PrepGPI::query(), XrdSsiAlert::SetInfo(), and XrdOfsTPCJob::Sync().
|
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. |
Definition at line 342 of file XrdOucErrInfo.hh.
References dOff, ErrInfo, XrdOucEI::message, and strlcpy().
Referenced by XrdCmsResp::Alloc().
|
inline |
Set error code and error text.
code | - The error number describing the error. |
emsg | - The error message text. |
Definition at line 147 of file XrdOucErrInfo.hh.
References XrdOucEI::code, dataBuff, emsg(), ErrInfo, XrdOucEI::message, XrdOucBuffer::Recycle(), and strlcpy().
Referenced by XrdSecsssKT::XrdSecsssKT(), XrdBwmHandle::Activate(), XrdCmsResp::Alloc(), XrdSsiFileSess::AttnInfo(), XrdSecProtocolunix::Authenticate(), XrdSfsDirectory::autoStat(), XrdSfsFile::checkpoint(), XrdSfsFileSystem::chksum(), XrdSsiSfs::chksum(), XrdOfs::chksum(), XrdSsiSfs::chmod(), XrdCmsParser::Decode(), XrdCmsClientMan::delayResp(), XrdBwm::Emsg(), XrdDigFS::Emsg(), XrdOfs::Emsg(), XrdSfsNative::Emsg(), XrdSsiSfs::exists(), XrdOfsTPCInfo::Fail(), XrdOfsTPC::Fatal(), XrdSecProtocolsss::Fatal(), XrdOfs::FAttr(), XrdSfsFileSystem::FAttr(), XrdBwmFile::fctl(), XrdDigFile::fctl(), XrdOfsFile::fctl(), XrdSfsNativeFile::fctl(), XrdThrottle::File::fctl(), XrdCmsFinderRMT::Forward(), XrdSsiSfs::fsctl(), XrdDigFS::fsctl(), XrdSfsNative::fsctl(), XrdOfs::fsctl(), XrdPfcFSctl::FSctl(), XrdSecPManager::Get(), XrdDigConfig::GetLocResp(), XrdThrottle::File::getMmap(), XrdSecServer::getProtocol(), XrdSfsFileSystem::gpFile(), XrdCmsRedirLocal::Locate(), XrdCmsFinderRMT::Locate(), XrdCmsFinderTRG::Locate(), XrdSsiSfs::mkdir(), XrdOfsFile::open(), XrdThrottle::File::open(), XrdSfsFile::pgWrite(), XrdSecServer::PostProcess(), XrdCmsFinderRMT::Prepare(), XrdOfsPrepGPIReal::PrepGPI::query(), XrdSfsFile::readv(), XrdSsiSfs::rem(), XrdSsiSfs::remdir(), XrdSsiSfs::rename(), XrdOfs::rename(), XrdOucCallBack::Reply(), XrdCmsFinderRMT::Space(), XrdBwm::Stall(), XrdOfs::Stall(), XrdSsiSfs::stat(), XrdOfsTPCJob::Sync(), XrdSsiSfs::truncate(), XrdSfsFile::writev(), XrdSecGetProtocol(), XrdSecProtocolgsiObject(), XrdSecProtocolkrb5Init(), XrdSecProtocolkrb5Object(), XrdSecProtocolpwdObject(), and XrdSecProtocolunixObject().
|
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. |
Definition at line 163 of file XrdOucErrInfo.hh.
References XrdOucEI::code, dataBuff, ErrInfo, XrdOucEI::message, XrdOucBuffer::Recycle(), and strlcpy().
|
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. |
Definition at line 183 of file XrdOucErrInfo.hh.
References XrdOucEI::code, dataBuff, ErrInfo, and XrdOucBuffer::Recycle().
|
inline |
Set the monitoring identifier.
Definition at line 362 of file XrdOucErrInfo.hh.
References mID.
Referenced by XrdCmsResp::Alloc().
|
inline |
Set user pointer.
user | - Pointer to a stable storage area containing the username. |
Definition at line 195 of file XrdOucErrInfo.hh.
References ErrInfo, and XrdOucEI::user.
Referenced by XrdCmsResp::Alloc().
|
inline |
Set user capabilties.
Definition at line 395 of file XrdOucErrInfo.hh.
References ErrInfo, and XrdOucEI::ucap.
union { ... } |
|
protected |
Definition at line 468 of file XrdOucErrInfo.hh.
Referenced by extData(), getErrText(), getErrTextLen(), operator=(), Reset(), and setErrInfo().
|
protected |
Definition at line 466 of file XrdOucErrInfo.hh.
Referenced by getErrData(), operator=(), and setErrData().
|
protected |
Definition at line 460 of file XrdOucErrInfo.hh.
Referenced by XrdCmsResp::Alloc(), getEnv(), getErrCB(), operator=(), setEnv(), and setErrCB().
|
protected |
Definition at line 459 of file XrdOucErrInfo.hh.
Referenced by clear(), getErrData(), getErrInfo(), getErrText(), getErrTextLen(), getErrUser(), getMsgBuff(), getUCap(), operator=(), Reset(), setErrCode(), setErrData(), setErrInfo(), setErrUser(), and setUCap().
|
protected |
Definition at line 465 of file XrdOucErrInfo.hh.
Referenced by getErrMid(), operator=(), and setErrMid().
|
protected |
Definition at line 467 of file XrdOucErrInfo.hh.