lib/libUPnP/Neptune/Source/Core/NptDataBuffer.h

   1 /*****************************************************************
   2 |
   3 |   Neptune - Datagram Packets
   4 |
   5 | Copyright (c) 2002-2008, Axiomatic Systems, LLC.
   6 | All rights reserved.
   7 |
   8 | Redistribution and use in source and binary forms, with or without
   9 | modification, are permitted provided that the following conditions are met:
  10 |     * Redistributions of source code must retain the above copyright
  11 |       notice, this list of conditions and the following disclaimer.
  12 |     * Redistributions in binary form must reproduce the above copyright
  13 |       notice, this list of conditions and the following disclaimer in the
  14 |       documentation and/or other materials provided with the distribution.
  15 |     * Neither the name of Axiomatic Systems nor the
  16 |       names of its contributors may be used to endorse or promote products
  17 |       derived from this software without specific prior written permission.
  18 |
  19 | THIS SOFTWARE IS PROVIDED BY AXIOMATIC SYSTEMS ''AS IS'' AND ANY
  20 | EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  21 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22 | DISCLAIMED. IN NO EVENT SHALL AXIOMATIC SYSTEMS BE LIABLE FOR ANY
  23 | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  24 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  26 | ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  28 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 |
  30  ****************************************************************/
  31
  32 #ifndef _NPT_DATA_BUFFER_H_
  33 #define _NPT_DATA_BUFFER_H_
  34
  35 /*----------------------------------------------------------------------
  36 |   includes
  37 +---------------------------------------------------------------------*/
  38 #include "NptTypes.h"
  39 #include "NptConstants.h"
  40
  41 /*----------------------------------------------------------------------
  42 |   NPT_DataBuffer
  43 +---------------------------------------------------------------------*/
  44 class NPT_DataBuffer
  45 {
  46  public:
  47     // constructors & destructor
  48     NPT_DataBuffer();              // size unknown until first set
  49     NPT_DataBuffer(NPT_Size size); // initial size specified
  50     NPT_DataBuffer(const void* data, NPT_Size size, bool copy = true); // initial data and size specified
  51     NPT_DataBuffer(const NPT_DataBuffer& other);
  52     virtual ~NPT_DataBuffer();
  53
  54     // operators
  55     NPT_DataBuffer& operator=(const NPT_DataBuffer& copy);
  56     bool            operator==(const NPT_DataBuffer& other) const;
  57
  58     // data buffer handling methods
  59     virtual NPT_Result SetBuffer(NPT_Byte* buffer, NPT_Size bufferSize);
  60     virtual NPT_Result SetBufferSize(NPT_Size bufferSize);
  61     virtual NPT_Size   GetBufferSize() const { return m_BufferSize; }
  62     virtual NPT_Result Reserve(NPT_Size size);
  63     virtual NPT_Result Clear();
  64
  65     // data handling methods
  66     virtual const NPT_Byte* GetData() const { return m_Buffer; }
  67     virtual NPT_Byte*       UseData() { return m_Buffer; };
  68     virtual NPT_Size        GetDataSize() const { return m_DataSize; }
  69     virtual NPT_Result      SetDataSize(NPT_Size size);
  70     virtual NPT_Result      SetData(const NPT_Byte* data, NPT_Size dataSize);
  71
  72  protected:
  73     // members
  74     bool      m_BufferIsLocal;
  75     NPT_Byte* m_Buffer;
  76     NPT_Size  m_BufferSize;
  77     NPT_Size  m_DataSize;
  78
  79     // methods
  80     NPT_Result ReallocateBuffer(NPT_Size size);
  81 };
  82
  83 #endif // _NPT_DATA_BUFFER_H_