XrdClBuffer.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Copyright (c) 2011-2012 by European Organization for Nuclear Research (CERN)
// Author: Lukasz Janyst <ljanyst@cern.ch>
//------------------------------------------------------------------------------
// 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_BUFFER_HH__
#define __XRD_CL_BUFFER_HH__
 
#include <cstdlib>
#include <cstdint>
#include <new>
#include <cstring>
#include <string>
 
namespace XrdCl
{
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class Buffer
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Buffer( uint32_t size = 0 ): pBuffer(0), pSize(0), pCursor(0)
      {
        if( size )
        {
          Allocate( size );
        }
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Buffer( Buffer &&buffer )
      {
        Steal( std::move( buffer ) );
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Buffer& operator=( Buffer && buffer )
      {
        Steal( std::move( buffer ) );
        return *this;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual ~Buffer() { Free(); }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      const char *GetBuffer( uint32_t offset = 0 ) const
      {
        return pBuffer+offset;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      char *GetBuffer( uint32_t offset = 0 )
      {
        return pBuffer+offset;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void ReAllocate( uint32_t size )
      {
        pBuffer = (char *)realloc( pBuffer, size );
        if( !pBuffer )
          throw std::bad_alloc();
        pSize = size;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Free()
      {
        free( pBuffer );
        pBuffer = 0;
        pSize   = 0;
        pCursor = 0;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Allocate( uint32_t size )
      {
        if( !size )
         return;
 
        pBuffer = (char *)malloc( size );
        if( !pBuffer )
          throw std::bad_alloc();
        pSize = size;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Zero()
      {
        memset( pBuffer, 0, pSize );
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      uint32_t GetSize() const
      {
        return pSize;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      uint32_t GetCursor() const
      {
        return pCursor;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetCursor( uint32_t cursor )
      {
        pCursor = cursor;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void AdvanceCursor( uint32_t delta )
      {
        pCursor += delta;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Append( const char *buffer, uint32_t size )
      {
        uint32_t remaining = pSize-pCursor;
        if( remaining < size )
          ReAllocate( pCursor+size );
 
        memcpy( pBuffer+pCursor, buffer, size );
        pCursor += size;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Append( const char *buffer, uint32_t size, uint32_t offset )
      {
        uint32_t remaining = pSize-offset;
        if( remaining < size )
          ReAllocate( offset+size );
 
        memcpy( pBuffer+offset, buffer, size );
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      char *GetBufferAtCursor()
      {
        return GetBuffer( pCursor );
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      const char *GetBufferAtCursor() const
      {
        return GetBuffer( pCursor );
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void FromString( const std::string str )
      {
        ReAllocate( str.length()+1 );
        memcpy( pBuffer, str.c_str(), str.length() );
        pBuffer[str.length()] = 0;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      std::string ToString() const
      {
        char *bf = new char[pSize+1];
        bf[pSize] = 0;
        memcpy( bf, pBuffer, pSize );
        std::string tmp = bf;
        delete [] bf;
        return tmp;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Grab( char *buffer, uint32_t size )
      {
        Free();
        pBuffer = buffer;
        pSize   = size;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      char *Release()
      {
        char *buffer = pBuffer;
        pBuffer = 0;
        pSize   = 0;
        pCursor = 0;
        return buffer;
      }
 
    protected:
 
      void Steal( Buffer &&buffer )
      {
        pBuffer = buffer.pBuffer;
        buffer.pBuffer = 0;
 
        pSize = buffer.pSize;
        buffer.pSize = 0;
 
        pCursor = buffer.pCursor;
        buffer.pCursor = 0;
      }
 
    private:
 
      Buffer( const Buffer& );
      Buffer& operator=( const Buffer& );
 
      char     *pBuffer;
      uint32_t  pSize;
      uint32_t  pCursor;
  };
}
 
#endif // __XRD_CL_BUFFER_HH__