XrdXrootdCallBack Class Reference

#include <XrdXrootdCallBack.hh>

Inheritance diagram for XrdXrootdCallBack:

Collaboration diagram for XrdXrootdCallBack:

Public Member Functions
	XrdXrootdCallBack (const char *opn, const char opc)
	~XrdXrootdCallBack ()
void	Done (int &Result, XrdOucErrInfo *eInfo, const char *Path=0)
const char *	Func ()
char	Oper ()
int	Same (unsigned long long arg1, unsigned long long arg2)
void	sendError (int rc, XrdOucErrInfo *eInfo, const char *Path)
void	sendResp (XrdOucErrInfo *eInfo, XResponseType xrt, int *Data=0, const char *Msg=0, int Mlen=0)
void	sendVesp (XrdOucErrInfo *eInfo, XResponseType xrt, struct iovec *ioV, int ioN)
Public Member Functions inherited from XrdOucEICB
	XrdOucEICB ()
	Constructor and destructor. More...
virtual	~XrdOucEICB ()

Static Public Member Functions
static void	setVals (XrdSysError *erp, XrdXrootdStats *SIp, XrdScheduler *schp, int port)

Detailed Description

Definition at line 43 of file XrdXrootdCallBack.hh.

Constructor & Destructor Documentation

XrdXrootdCallBack()

XrdXrootdCallBack::XrdXrootdCallBack ( const char *  opn, const char  opc  )

inline

Definition at line 72 of file XrdXrootdCallBack.hh.

                                     : Opname(opn), Opcode(opc) {}

~XrdXrootdCallBack()

XrdXrootdCallBack::~XrdXrootdCallBack ( )

inline

Definition at line 75 of file XrdXrootdCallBack.hh.

{}

Member Function Documentation

Done()

void XrdXrootdCallBack::Done ( int &  Result, XrdOucErrInfo *  eInfo, const char *  Path = 0  )

virtual

Invoke a callback after an operation completes.

Parameters

Result	- the original function's result (may be changed).
eInfo	- Associated error information. The eInfo object may not be modified until it's own callback Done() method is called, if supplied. If the callback function in eInfo is zero, then the eInfo object is deleted by the invoked callback. Otherwise, that method must be invoked by this callback function after the actual callback message is sent. This allows the callback requestor to do post-processing and be asynchronous being assured that the callback completed.
Path	- Optionally, the path related to thid request. It is used for tracing and detailed monitoring purposes.

Implements XrdOucEICB.

Definition at line 251 of file XrdXrootdCallBack.cc.

{
   XrdXrootdCBJob *cbj;
 
// Sending an async response may take a long time. So, we schedule the task
// to run asynchronously from the forces that got us here.
//
   if (!(cbj = XrdXrootdCBJob::Alloc(this, eInfo, Path, Result)))
      {eDest->Emsg("Done",ENOMEM,"get call back job; user",eInfo->getErrUser());
       if (eInfo->getErrCB()) eInfo->getErrCB()->Done(Result, eInfo);
          else delete eInfo;
      } else Sched->Schedule((XrdJob *)cbj);
}

References XrdXrootdCBJob::Alloc(), XrdOucEICB::Done(), eDest, XrdSysError::Emsg(), XrdOucErrInfo::getErrCB(), XrdOucErrInfo::getErrUser(), Path, XrdGlobal::Sched, and XrdScheduler::Schedule().

Here is the call graph for this function:

Func()

const char* XrdXrootdCallBack::Func ( )

inline

Definition at line 51 of file XrdXrootdCallBack.hh.

{return Opname;}

Referenced by XrdXrootdCBJob::DoIt().

Here is the caller graph for this function:

Oper()

char XrdXrootdCallBack::Oper ( )

inline

Definition at line 53 of file XrdXrootdCallBack.hh.

{return Opcode;}

Same()

int XrdXrootdCallBack::Same ( unsigned long long  arg1, unsigned long long  arg2  )

virtual

Determine if two callback arguments refer to the same client.

Parameters

arg1	- The first callback argument.
arg2	- The second callback argument.

Returns

!0 - The arguments refer to the same client.

=0 - The arguments refer to the different clients.

Implements XrdOucEICB.

Definition at line 271 of file XrdXrootdCallBack.cc.

{
   XrdXrootdReqID ReqID1(arg1), ReqID2(arg2);
   unsigned char sid1[2], sid2[2];
   unsigned int  inst1, inst2;
            int  lid1, lid2;
 
   ReqID1.getID(sid1, lid1, inst1);
   ReqID2.getID(sid2, lid2, inst2);
   return lid1 == lid2;
}

References XrdXrootdReqID::getID().

Here is the call graph for this function:

sendError()

void XrdXrootdCallBack::sendError	(	int	rc,
		XrdOucErrInfo *	eInfo,
		const char *	Path
	)

Definition at line 287 of file XrdXrootdCallBack.cc.

{
   static const char *TraceID = "fsError";
   static int Xserr = kXR_ServerError;
   int ecode;
   const char *eMsg = eInfo->getErrText(ecode);
   const char *User = eInfo->getErrUser();
 
// Process the data response vector (we need to do this here)
//
   if (rc == SFS_DATAVEC)
      {if (ecode > 1) sendVesp(eInfo, kXR_ok, (struct iovec *)eMsg, ecode);
         else         sendResp(eInfo, kXR_ok, 0);
       return;
      }
 
// Optimize error message handling here
//
   if (eMsg && !*eMsg) eMsg = 0;
 
// Process standard errors
//
   if (rc == SFS_ERROR)
      {SI->errorCnt++;
       rc = XProtocol::mapError(ecode);
       sendResp(eInfo, kXR_error, &rc, eMsg, eInfo->getErrTextLen()+1);
       return;
      }
 
// Process the redirection (error msg is host:port)
//
   if (rc == SFS_REDIRECT)
      {SI->redirCnt++;
       if (ecode <= 0) ecode = (ecode ? -ecode : Port);
       TRACE(REDIR, User <<" async redir to " << eMsg <<':' <<ecode <<' '
                         <<(Path ? Path : ""));
       sendResp(eInfo, kXR_redirect, &ecode, eMsg, eInfo->getErrTextLen());
       if (XrdXrootdMonitor::Redirect() && Path)
           XrdXrootdMonitor::Redirect(eInfo->getErrMid(),eMsg,ecode,Opcode,Path);
       return;
      }
 
// Process the deferal
//
   if (rc >= SFS_STALL)
      {SI->stallCnt++;
       TRACE(STALL, "Stalling " <<User <<" for " <<rc <<" sec");
       sendResp(eInfo, kXR_wait, &rc, eMsg, eInfo->getErrTextLen()+1);
       return;
      }
 
// Process the data response
//
   if (rc == SFS_DATA)
      {if (ecode) sendResp(eInfo, kXR_ok, 0, eMsg, ecode);
         else     sendResp(eInfo, kXR_ok, 0);
       return;
      }
 
// Unknown conditions, report it
//
   {char buff[64];
    SI->errorCnt++;
    ecode = sprintf(buff, "Unknown sfs response code %d", rc);
    eDest->Emsg("sendError", buff);
    sendResp(eInfo, kXR_error, &Xserr, buff, ecode+1);
    return;
   }
}

References eDest, XrdSysError::Emsg(), eMsg, XrdXrootdStats::errorCnt, XrdOucErrInfo::getErrMid(), XrdOucErrInfo::getErrText(), XrdOucErrInfo::getErrTextLen(), XrdOucErrInfo::getErrUser(), kXR_error, kXR_ok, kXR_redirect, kXR_ServerError, kXR_wait, XProtocol::mapError(), Path, XrdXrootdStats::redirCnt, XrdXrootdMonitor::Redirect(), sendResp(), sendVesp(), SFS_DATA, SFS_DATAVEC, SFS_ERROR, SFS_REDIRECT, SFS_STALL, XrdXrootd::SI, XrdXrootdStats::stallCnt, and TRACE.

Referenced by XrdXrootdCBJob::DoIt().

Here is the call graph for this function:

Here is the caller graph for this function:

sendResp()

void XrdXrootdCallBack::sendResp	(	XrdOucErrInfo *	eInfo,
		XResponseType	xrt,
		int *	Data = 0,
		const char *	Msg = 0,
		int	Mlen = 0
	)

Definition at line 363 of file XrdXrootdCallBack.cc.

{
   static const char *TraceID = "sendResp";
   struct iovec       rspVec[4];
   XrdXrootdReqID     ReqID;
   int                dlen = 0, n = 1;
   kXR_int32          xbuf;
 
   if (Data)
      {xbuf = static_cast<kXR_int32>(htonl(*Data));
               rspVec[n].iov_base = (caddr_t)(&xbuf);
       dlen  = rspVec[n].iov_len  = sizeof(xbuf); n++;           // 1
      }
    if (Msg && *Msg)
       {        rspVec[n].iov_base = (caddr_t)Msg;
        dlen += rspVec[n].iov_len  = Mlen; n++;                  // 2
       }
 
// Set the destination
//
   ReqID.setID(eInfo->getErrArg());
 
// Send the async response
//
   if (XrdXrootdResponse::Send(ReqID, Status, rspVec, n, dlen) < 0)
      eDest->Emsg("sendResp", eInfo->getErrUser(), Opname, 
                  "async resp aborted; user gone.");
      else if (TRACING(TRACE_RSP))
              {XrdXrootdResponse theResp;
               theResp.Set(ReqID.Stream());
               TRACE(RSP, eInfo->getErrUser() <<" async " <<theResp.ID()
                          <<' ' <<Opname <<" status " <<Status);
              }
 
// Release any external buffer from the errinfo object
//
   if (eInfo->extData()) eInfo->Reset();
}

References eDest, XrdSysError::Emsg(), XrdOucErrInfo::extData(), XrdOucErrInfo::getErrArg(), XrdOucErrInfo::getErrUser(), XrdXrootdResponse::ID(), XrdOucErrInfo::Reset(), XrdXrootdResponse::Send(), XrdXrootdResponse::Set(), XrdXrootdReqID::setID(), TRACE, TRACE_RSP, and TRACING.

Referenced by XrdXrootdCBJob::DoIt(), and sendError().

Here is the call graph for this function:

Here is the caller graph for this function:

sendVesp()

void XrdXrootdCallBack::sendVesp	(	XrdOucErrInfo *	eInfo,
		XResponseType	xrt,
		struct iovec *	ioV,
		int	ioN
	)

Definition at line 410 of file XrdXrootdCallBack.cc.

{
   static const char *TraceID = "sendVesp";
   XrdXrootdReqID     ReqID;
   int                dlen = 0;
 
// Calculate the amount of data being sent
//
   for (int i = 1; i < ioN; i++) dlen += ioV[i].iov_len;
 
// Set the destination
//
   ReqID.setID(eInfo->getErrArg());
 
// Send the async response
//
   if (XrdXrootdResponse::Send(ReqID, Status, ioV, ioN, dlen) < 0)
      eDest->Emsg("sendResp", eInfo->getErrUser(), Opname, 
                  "async resp aborted; user gone.");
      else if (TRACING(TRACE_RSP))
              {XrdXrootdResponse theResp;
               theResp.Set(ReqID.Stream());
               TRACE(RSP, eInfo->getErrUser() <<" async " <<theResp.ID()
                          <<' ' <<Opname <<" status " <<Status);
              }
 
// Release any external buffer from the errinfo object
//
   if (eInfo->extData()) eInfo->Reset();
}

References eDest, XrdSysError::Emsg(), XrdOucErrInfo::extData(), XrdOucErrInfo::getErrArg(), XrdOucErrInfo::getErrUser(), XrdXrootdResponse::ID(), XrdOucErrInfo::Reset(), XrdXrootdResponse::Send(), XrdXrootdResponse::Set(), XrdXrootdReqID::setID(), XrdXrootdReqID::Stream(), TRACE, TRACE_RSP, and TRACING.

Referenced by sendError().

Here is the call graph for this function:

Here is the caller graph for this function:

setVals()

void XrdXrootdCallBack::setVals ( XrdSysError *  erp, XrdXrootdStats *  SIp, XrdScheduler *  schp, int  port  )

static

Definition at line 448 of file XrdXrootdCallBack.cc.

{
// Set values into out unnamed static space
//
   eDest = erp;
   SI    = SIp;
   Sched = schp;
   Port  = port;
}

References eDest, XrdGlobal::Sched, and XrdXrootd::SI.

Referenced by XrdXrootdProtocol::Configure().

Here is the caller graph for this function:

---

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

• XrdXrootdCallBack.hh
• XrdXrootdCallBack.cc