XrdHttpTpcPMarkManager.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// This file is part of XrdHttpTpcTPC
//
// Copyright (c) 2023 by European Organization for Nuclear Research (CERN)
// Author: Cedric Caffy <ccaffy@cern.ch>
// File Date: Oct 2023
//------------------------------------------------------------------------------
// 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 General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with XRootD.  If not, see <http://www.gnu.org/licenses/>.
//------------------------------------------------------------------------------
#ifndef XROOTD_PMARKMANAGER_HH
#define XROOTD_PMARKMANAGER_HH
 
#include "XrdNet/XrdNetPMark.hh"
#include "XrdSec/XrdSecEntity.hh"
#include "XrdNet/XrdNetAddrInfo.hh"
#include "XrdNet/XrdNetAddr.hh"
#include "XrdHttp/XrdHttpExtHandler.hh"
 
#include <map>
#include <memory>
#include <queue>
 
namespace TPC {
  enum class TpcType;
}

namespace XrdHttpTpc
{
class PMarkManager {
public:

  class SocketInfo {
  public:
    SocketInfo(int fd, const struct sockaddr * sockP);
    XrdNetAddr netAddr;
    XrdSecEntity client;
  };
 
  PMarkManager(XrdHttpExtReq &req, const TPC::TpcType type);
 
  PMarkManager(XrdNetPMark *pmark, int sciTag, const TPC::TpcType type);

  bool connect(int fd, const struct sockaddr * sockP, size_t sockPLen, uint32_t timeout_sec, std::stringstream & err);

  bool isEnabled() const;

  void startTransfer();

  void beginPMarks();

  void endPmark(int fd);
 
  virtual ~PMarkManager() = default;
private:
  void addFd(int fd, const struct sockaddr * sockP);
 
  // The queue of socket information from which we will create the packet marking handles
  std::queue<SocketInfo> mSocketInfos;
  // The map of socket FD and packet marking handles
  std::map<int,std::unique_ptr<XrdNetPMark::Handle>> mPmarkHandles;
  // The instance of the packet marking functionality
  XrdNetPMark *mPmark;
  // SciTag provided by the user; extracted from the request
  int mSciTag;
  // Path to the resource
  const char *mResource;
  // Is true when startTransfer(...) has been called
  bool mTransferWillStart;
  // Is true if this transfer is a HTTP TPC PULL transfer, false otherwise
  // by default is true
  TPC::TpcType mTpcType;
};
} // namespace XrdHttpTpc
 
#endif //XROOTD_PMARKMANAGER_HH