XrdOucPgrwUtils.hh

Go to the documentation of this file.

#ifndef __XRDOUCPGRWUTILS_HH__
#define __XRDOUCPGRWUTILS_HH__
/******************************************************************************/
/*                                                                            */
/*                    X r d O u c P g r w U t i l s . h h                     */
/*                                                                            */
/* (c) 2021 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.       */
/******************************************************************************/
 
#include <cstdint>
#include <vector>
#include <sys/types.h>
 
class XrdOucPgrwUtils
{
public:
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static void csCalc(const char* data, off_t offs, size_t count,
                   uint32_t* csval);
 
static void csCalc(const char* data, off_t offs, size_t count,
                   std::vector<uint32_t> &csvec);
 
//------------------------------------------------------------------------------
//| applying the pgRead/pgWrite requirements.
//------------------------------------------------------------------------------
 
static int   csNum(off_t offs, int count);
 
//------------------------------------------------------------------------------
//| applying the pgRead/pgWrite requirements and return the length of the first
//------------------------------------------------------------------------------
 
static int   csNum(off_t offs, int count, int &fLen, int &lLen);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
struct dataInfo
      {const char*     data;   
       const uint32_t* csval;  
       off_t           offs;   
       int             count;  
 
       dataInfo(const char* dP, const uint32_t* cP, off_t o, int n)
               : data(dP), csval(cP), offs(o), count(n) {}
      };
 
static bool  csVer(dataInfo &dInfo, off_t &bado, int &badc);
 
//------------------------------------------------------------------------------
//| pgRead/pgWrite requirements.
//------------------------------------------------------------------------------
 
struct Layout
{
off_t       bOffset; 
int         dataLen; 
int         sockLen; 
int         fLen;    
int         lLen;    
const char *eWhy;    
};
 
static int  recvLayout(Layout &layout, off_t offs, int dlen, int bsz=0);
 
static int  sendLayout(Layout &layout, off_t offs, int dlen, int bsz=0);
 
             XrdOucPgrwUtils() {}
            ~XrdOucPgrwUtils() {}
 
private:
};
#endif