XrdXrootdRedirHelper.hh

Go to the documentation of this file.

#ifndef __XRDXROOTDREDIRHELPER__
#define __XRDXROOTDREDIRHELPER__
/******************************************************************************/
/*                                                                            */
/*               X r d X r o o t d R e d i r H e l p e r . h h                */
/*                                                                            */
/* (c) 2026 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*                                                                            */
/* 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/>.        */
/******************************************************************************/
 
#include <cstdint>
#include <ctime>
#include <functional>
#include <string>
 
class XrdNetAddrInfo;
class XrdSysError;
class XrdXrootdRedirPI;
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
class XrdXrootdRedirHelper
{
public:
 
   //----------------------------------------------------------------------------
   //----------------------------------------------------------------------------
 
   enum class Outcome { Unchanged, Replaced, Error };
 
   //----------------------------------------------------------------------------
   //----------------------------------------------------------------------------
 
   static void Init(XrdXrootdRedirPI *pi, XrdSysError *eDest, int ipHold);
 
   //----------------------------------------------------------------------------
   //----------------------------------------------------------------------------
 
   static bool IsActive();
 
   //----------------------------------------------------------------------------
   //----------------------------------------------------------------------------
 
   static Outcome Redirect(const char *trg, int &port,
                           XrdNetAddrInfo &clientAddr,
                           std::string &outTarget, std::string &errMsg);
 
   //----------------------------------------------------------------------------
   //----------------------------------------------------------------------------
 
   static bool ParseURL(const char *url, std::string &urlHead,
                        std::string &host, std::string &port,
                        std::string &urlTail);
 
   //----------------------------------------------------------------------------
   //----------------------------------------------------------------------------
   static void SetClockForTesting(std::function<time_t()> nowFn);
 
private:
 
   XrdXrootdRedirHelper()  = delete;
   ~XrdXrootdRedirHelper() = delete;
};
 
#endif