XrdClZipArchiveReader.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Copyright (c) 2011-2014 by European Organization for Nuclear Research (CERN)
// Author: Michal Simon <michal.simon@cern.ch>
//------------------------------------------------------------------------------
// 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 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/>.
//
// In applying this licence, CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
//------------------------------------------------------------------------------
 
#ifndef SRC_XRDCL_XRDCLZIPARCHIVEREADER_HH_
#define SRC_XRDCL_XRDCLZIPARCHIVEREADER_HH_
 
#include "XrdClXRootDResponses.hh"
 
namespace XrdCl
{
 
class ZipArchiveReaderImpl;
class File;
 
//----------------------------------------------------------------------------
//----------------------------------------------------------------------------
class ZipArchiveReader
{
  public:
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ZipArchiveReader( File &archive );
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual ~ZipArchiveReader();
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    XRootDStatus Open( const std::string &url, ResponseHandler *handler, uint16_t timeout = 0 );
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    XRootDStatus Open( const std::string &url, uint16_t timeout = 0 );
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    XRootDStatus Read( const std::string &filename, uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, uint16_t timeout = 0 );
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    XRootDStatus Read( const std::string &filename, uint64_t offset, uint32_t size, void *buffer, uint32_t &bytesRead, uint16_t timeout = 0 );
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    XRootDStatus Bind( const std::string &filename );
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    XRootDStatus Read( uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, uint16_t timeout = 0 );
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    XRootDStatus Read( uint64_t offset, uint32_t size, void *buffer, uint32_t &bytesRead, uint16_t timeout = 0 );
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    XRootDStatus List( DirectoryList *&list );
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    XRootDStatus Close( ResponseHandler *handler, uint16_t timeout = 0 );
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    XRootDStatus Close( uint16_t timeout  = 0 );
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    XRootDStatus GetSize( const std::string &filename, uint64_t &size ) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool IsOpen() const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    XRootDStatus ZCRC32( const std::string &filename, std::string &checksum );
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    XRootDStatus ZCRC32( std::string &checksum );
 
  private:
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ZipArchiveReaderImpl *pImpl;
};
 
} /* namespace XrdCl */
 
#endif /* SRC_XRDCL_XRDCLZIPARCHIVEREADER_HH_ */