XrdXrootdGPFile.hh

Go to the documentation of this file.

#ifndef __XRDXROOTDGPFILE_H__
#define __XRDXROOTDGPFILE_H__
/******************************************************************************/
/*                                                                            */
/*                    X r d X r o o t d G P F i l e . h h                     */
/*                                                                            */
/* (c) 2019 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*                            All Rights Reserved                             */
/*   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.       */
/******************************************************************************/
 
 
class XrdOucEnv;
class XrdOucErrInfo;
class XrdSecEntity;
class XrdSfs;
class XrdXrootdGPFAgent;
 
/******************************************************************************/
/*             C l a s s   X r d X r o o t d G P F i l e I n f o              */
/******************************************************************************/
  
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
class XrdXrootdGPFileInfo
{
public:
 
const char *cksType;      
const char *cksValue;     
const char *src;          
const char *srcCgi;       
const char *dst;          
const char *srcCgi;       
uint16_t    pingsec;      
uint16_t    streams;      
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
bool Completed(const char *eMsg=0, int eNum=0);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
enum Status {isPending = 0, 
             isCopying = 1, 
             isProving = 2  
            }
 
bool Update(uint64_t xfrsz, Status stat);
 
/******************************************************************************/
/*              C o n s t r u c t o r   &   D e s t r u c t o r               */
/******************************************************************************/
  
     XrdXrootdGPFileInfo(XrdXrootdGPFAgent &gpf)
                        : cksType(0), cksValue(0),
                          src(0), srcCgi(0), dst(0), dstCgi(0),
                          pingSec(0), streams(0),
                          gpfAgent(gpf) {}
 
    ~XrdXrootdGPFileInfo() {}
 
private:
 
XrdXrootdGPFAgent &gpfAgent;
};
 
/******************************************************************************/
/*                 c l a s s   X r d X r o o t d G P F i l e                  */
/******************************************************************************/
  
class XrdXrootdGPFile
{
public:
 
//------------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual void getFile(const XrdXrootdGPFileInfo &gargs,
                     const XrdSecEntity        *client=0) = 0;
 
//------------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual void putFile(const XrdXrootdGPFileInfo &pargs,
                     const XrdSecEntity        *client=0) = 0;
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
             XrdXrootdGPFile() {}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual     ~XrdXrootdGPFile() {}
};
 
/******************************************************************************/
/*                    X r d X r o o t d g e t G P F i l e                     */
/******************************************************************************/
  
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
class XrdSysError;
 
typedef XrdXrootdGPFile *(*XrdOfsgetPrepare_t)(XrdSysError *eDest,
                                             const char  *confg,
                                             const char  *parms,
                                             XrdSfs      *theSfs,
                                             XrdOucEnv   *envP
                                            );
 
#define XrdOfsgetPrepareArguments            XrdSysError *eDest,\
                                             const char  *confg,\
                                             const char  *parms,\
                                             XrdSfs      *theSfs,\
                                             XrdOucEnv   *envP
/*
extern "C" XrdXrootdGPFile_t *XrdXrootdgetGPFile;
*/
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
#endif