XrdSsiResponder.hh

Go to the documentation of this file.

#ifndef __XRDSSIRESPONDER_HH__
#define __XRDSSIRESPONDER_HH__
/******************************************************************************/
/*                                                                            */
/*                    X r d S s i R e s p o n d e r . 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 <cstdlib>
#include <cstring>
 
#include "XrdSsi/XrdSsiRequest.hh"
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
class XrdSsiStream;
 
class XrdSsiResponder
{
public:
friend class XrdSsiRequest;
friend class XrdSsiRRAgent;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static const int MaxDirectXfr = 2097152; //< Max (metadata+data) direct xfr
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
        void    BindRequest(XrdSsiRequest   &rqstR);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
        bool    UnBindRequest();
 
protected:
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
        void   Alert(XrdSsiRespInfoMsg &aMsg);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual void   Finished(      XrdSsiRequest  &rqstR,
                        const XrdSsiRespInfo &rInfo,
                              bool            cancel=false) = 0;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
        char  *GetRequest(int &dlen);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
        void   ReleaseRequestBuffer();
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
enum Status {wasPosted=0, 
             notPosted,   
             notActive    
            };
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static const int MaxMetaDataSZ = 2097152; 
 
       Status  SetMetadata(const char *buff, int blen);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
       Status  SetErrResponse(const char *eMsg, int eNum);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
inline Status  SetNilResponse() {return SetResponse((const char *)0,0);}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
       Status  SetResponse(const char *buff, int blen);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
       Status  SetResponse(long long fsize, int fdnum);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
       Status  SetResponse(XrdSsiStream *strmP);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
               XrdSsiResponder();
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
protected:
 
virtual       ~XrdSsiResponder();
 
private:
 
// The spMutex protects the reqP pointer. It is a hiearchical mutex in that it
// may be obtained prior to obtaining the mutex protecting the request without
// fear of a deadlock (the reverse is not possible). If reqP is zero then
// this responder is not bound to a request.
//
XrdSsiMutex    spMutex;
XrdSsiRequest *reqP;
long long      rsvd1; // Reserved fields for extensions with ABI compliance
long long      rsvd2;
long long      rsvd3;
};
#endif