XrdClLocalFileHandler.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Copyright (c) 2017 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH 
// Author: Paul-Niklas Kramp <p.n.kramp@gsi.de>
//------------------------------------------------------------------------------
// 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 __XRD_CL_LOCAL_FILE_HANDLER_HH__
#define __XRD_CL_LOCAL_FILE_HANDLER_HH__
#include "XrdCl/XrdClJobManager.hh"
#include "XrdCl/XrdClLocalFileTask.hh"
#include "XrdCl/XrdClDefaultEnv.hh"
#include "XrdCl/XrdClLog.hh"
 
#include <sys/uio.h>
 
namespace XrdCl
{
  class Message;
  struct MessageSendParams;
 
  class LocalFileHandler
  {
    public:
 
      LocalFileHandler();
 
      ~LocalFileHandler();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Open( const std::string &url, uint16_t flags, uint16_t mode,
          ResponseHandler *handler, uint16_t timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Open( const URL *url, const Message *req, AnyObject *&resp );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Close( ResponseHandler *handler, uint16_t timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Stat( ResponseHandler *handler, uint16_t timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Read( uint64_t offset, uint32_t size, void *buffer,
          ResponseHandler *handler, uint16_t timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus ReadV( uint64_t         offset,
                          struct iovec    *iov,
                          int              iovcnt,
                          ResponseHandler *handler,
                          uint16_t         timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Write( uint64_t offset, uint32_t size, const void *buffer,
          ResponseHandler *handler, uint16_t timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Sync( ResponseHandler *handler, uint16_t timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Truncate( uint64_t size, ResponseHandler *handler,
          uint16_t timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus VectorRead( const ChunkList &chunks, void *buffer,
          ResponseHandler *handler, uint16_t timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus VectorWrite( const ChunkList &chunks,
          ResponseHandler *handler, uint16_t timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus WriteV( uint64_t            offset,
                           ChunkList          *chunks,
                           ResponseHandler    *handler,
                           uint16_t            timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus QueueTask( XRootDStatus *st, AnyObject *obj,
          ResponseHandler *handler );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Fcntl( const Buffer &arg, ResponseHandler *handler,
          uint16_t timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Visa( ResponseHandler *handler, uint16_t timeout = 0 );
 
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus SetXAttr( const std::vector<xattr_t> &attrs,
                             ResponseHandler            *handler,
                             uint16_t                    timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus GetXAttr( const std::vector<std::string> &attrs,
                             ResponseHandler                *handler,
                             uint16_t                        timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus DelXAttr( const std::vector<std::string> &attrs,
                             ResponseHandler                *handler,
                             uint16_t                        timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus ListXAttr( ResponseHandler           *handler,
                              uint16_t                   timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static XRootDStatus MkdirPath( const std::string &path );
 
      void SetHostList( const HostList &hostList )
      {
        pHostList = hostList;
      }
 
      const HostList& GetHostList()
      {
        return pHostList;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus ExecRequest( const URL         &url,
                                Message           *msg,
                                ResponseHandler   *handler,
                                MessageSendParams &sendParams );
 
    private:
 
      XRootDStatus OpenImpl( const std::string &url, uint16_t flags,
                             uint16_t mode, AnyObject *&resp );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus XAttrImpl( kXR_char          code,
                              kXR_char          numattr,
                              size_t         bodylen,
                              char             *body,
                              ResponseHandler  *handler );
 
      //---------------------------------------------------------------------
      // Internal filedescriptor, which is used by all operations after open
      //---------------------------------------------------------------------
      int fd;
 
      //---------------------------------------------------------------------
      // The file URL
      //---------------------------------------------------------------------
      std::string pUrl;
 
      //---------------------------------------------------------------------
      // The host list returned in the user callback
      //---------------------------------------------------------------------
      HostList pHostList;
 
  };
}
#endif