XrdSsiRequest.hh

Go to the documentation of this file.

#ifndef __XRDSSIREQUEST_HH__
#define __XRDSSIREQUEST_HH__
/******************************************************************************/
/*                                                                            */
/*                      X r d S s i R e q u e s t . h h                       */
/*                                                                            */
/* (c) 2013 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* XRootD is free software: you can redistribute it and/or modify it under    */
/* the terms of the GNU Lesser General Public License as published by the     */
/* Free Software Foundation, either version 3 of the License, or (at your     */
/* option) any later version.                                                 */
/*                                                                            */
/* XRootD is distributed in the hope that it will be useful, but WITHOUT      */
/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or      */
/* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/******************************************************************************/
 
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
 
#include "XrdSsi/XrdSsiAtomics.hh"
#include "XrdSsi/XrdSsiErrInfo.hh"
#include "XrdSsi/XrdSsiRespInfo.hh"
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
class XrdSsiResponder;
 
class XrdSsiRequest
{
public:
friend class XrdSsiResponder;
friend class XrdSsiRRAgent;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
        bool    Finished(bool cancel=false);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
inline uint32_t GetDetachTTL() {return detTTL;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
std::string     GetEndPoint();
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
const char     *GetMetadata(int &dlen);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual char   *GetRequest(int &dlen) = 0;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
inline
const   char   *GetRequestID() {return reqID;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
        void    GetResponseData(char *buff, int  blen);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
        uint16_t GetTimeOut() {return tOut;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual bool    ProcessResponse(const XrdSsiErrInfo  &eInfo,
                                const XrdSsiRespInfo &rInfo)=0;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
enum PRD_Xeq {PRD_Normal = 0, PRD_Hold = 1, PRD_HoldLcl = 2};
 
virtual PRD_Xeq ProcessResponseData(const XrdSsiErrInfo  &eInfo, char *buff,
                                    int blen, bool last) {return PRD_Normal;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
        void   ReleaseRequestBuffer();
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
enum   RDR_How {RDR_All=0, RDR_Hold, RDR_Immed, RDR_Query, RDR_One, RDR_Post};
 
struct RDR_Info{int rCount; 
                int qCount; 
                int iAllow; 
                int fAllow; 
 
                RDR_Info() : rCount(0), qCount(0), iAllow(0), fAllow(0) {}
               };
 
static RDR_Info RestartDataResponse(RDR_How rhow, const char *reqid=0);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
                XrdSsiRequest(const char *reqid=0, uint16_t tmo=0);
 
protected:
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual void    Alert(XrdSsiRespInfoMsg &aMsg) {aMsg.RecycleMsg(false);}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual void    RelRequestBuffer() {}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
inline void     SetDetachTTL(uint32_t dttl) {detTTL = dttl;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
       void     SetTimeOut(uint16_t tmo) {tOut = tmo;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual        ~XrdSsiRequest() {}
 
private:
virtual void     BindDone() {}
        void     CleanUp();
        bool     CopyData(char *buff, int blen);
virtual void     Dispose() {}
 
const char      *reqID;
XrdSsiMutex     *rrMutex;
XrdSsiResponder *theRespond; // Set via XrdSsiResponder::BindRequest()
XrdSsiRespInfo   Resp;       // Set via XrdSsiResponder::SetResponse()
XrdSsiErrInfo    errInfo;
long long        rsvd1;
const char      *epNode;
uint32_t         detTTL;
uint16_t         tOut;
bool             onClient;
char             rsvd2;
};
#endif