ringbuf.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:8k
源码类别:

Symbian

开发平台:

C/C++

  1. /* ***** BEGIN LICENSE BLOCK ***** 
  2.  * Version: RCSL 1.0/RPSL 1.0 
  3.  *  
  4.  * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
  5.  *      
  6.  * The contents of this file, and the files included with this file, are 
  7.  * subject to the current version of the RealNetworks Public Source License 
  8.  * Version 1.0 (the "RPSL") available at 
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed 
  10.  * the file under the RealNetworks Community Source License Version 1.0 
  11.  * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
  12.  * in which case the RCSL will apply. You may also obtain the license terms 
  13.  * directly from RealNetworks.  You may not use this file except in 
  14.  * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
  15.  * applicable to this file, the RCSL.  Please see the applicable RPSL or 
  16.  * RCSL for the rights, obligations and limitations governing use of the 
  17.  * contents of the file.  
  18.  *  
  19.  * This file is part of the Helix DNA Technology. RealNetworks is the 
  20.  * developer of the Original Code and owns the copyrights in the portions 
  21.  * it created. 
  22.  *  
  23.  * This file, and the files included with this file, is distributed and made 
  24.  * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
  25.  * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
  26.  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
  27.  * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
  28.  * 
  29.  * Technology Compatibility Kit Test Suite(s) Location: 
  30.  *    http://www.helixcommunity.org/content/tck 
  31.  * 
  32.  * Contributor(s): 
  33.  *  
  34.  * ***** END LICENSE BLOCK ***** */ 
  35. #ifndef _RINGBUF_H_
  36. #define _RINGBUF_H_
  37. ///////////////////////////////////////////////////////////////////////////////
  38. // Class:   CIHXRingBuffer
  39. // Purpose: An IHXBuffer based circular buffer class
  40. // Author:  cts
  41. ///////////////////////////////////////////////////////////////////////////////
  42. class CIHXRingBuffer : public IHXBuffer
  43. {
  44. public:
  45.     ///////////////////////////////////////////////////////////////////////////
  46.     // Function:    CIHXRingBuffer
  47.     // Purpose:     Constructor that allocates a ring buffer and allocates
  48.     //              space for data wrapping before the actual buffer.  The
  49.     //              buffer looks like this |Wrap Bytes__|Buffer_______________|
  50.     //
  51.     // Params:      pClassFactory is the Real COM class factory pointer
  52.     //              ulBufSize is the size of the ring buffer
  53.     //              ulWrapSize is the size of the wrap data before the buffer
  54.     // Author:      cts
  55.     ///////////////////////////////////////////////////////////////////////////
  56.     CIHXRingBuffer(IHXCommonClassFactory *pClassFactory,
  57.                     UINT32 ulBufSize,
  58.                     UINT32 ulWrapSize);
  59.     ~CIHXRingBuffer();
  60.     ///////////////////////////////////////////////////////////////////////////
  61. // IUnknown methods
  62. ///////////////////////////////////////////////////////////////////////////
  63.     STDMETHOD(QueryInterface) (THIS_
  64. REFIID riid,
  65. void** ppvObj);
  66.     STDMETHOD_(ULONG32,AddRef) (THIS);
  67.     STDMETHOD_(ULONG32,Release) (THIS);
  68.     ///////////////////////////////////////////////////////////////////////////
  69. // IHXBuffer methods
  70. ///////////////////////////////////////////////////////////////////////////
  71.     STDMETHOD(Get)              (THIS_ REF(UCHAR*) pData, 
  72.                                  REF(ULONG32) ulLength);
  73.     STDMETHOD(Set)              (THIS_ const UCHAR* pData, 
  74.                                  ULONG32 ulLength);
  75.     STDMETHOD(SetSize)          (THIS_ ULONG32 ulLength);
  76.     STDMETHOD_(ULONG32,GetSize) (THIS);
  77.     STDMETHOD_(UCHAR*,GetBuffer)(THIS);
  78.     
  79.     ///////////////////////////////////////////////////////////////////////////
  80.     // Function:    Reset
  81.     // Purpose:     Flushes the buffer and resets all variables.
  82.     // Author:      cts
  83.     ///////////////////////////////////////////////////////////////////////////
  84.     void    Reset();
  85.     ///////////////////////////////////////////////////////////////////////////
  86.     // Function:    CopyData
  87.     // Purpose:     Copies data to the next write position of the ring buffer.
  88.     //              This function handles buffer wrapping.
  89.     // Params:      pData is data to copy into the buffer
  90.     //              ulBytes is the amount of data to copy
  91.     // Returns:     The amount of data copied.  If return is less than ulBytes
  92.     //              the buffer is full.
  93.     // Author:      cts
  94.     ///////////////////////////////////////////////////////////////////////////
  95.     UINT32  CopyData(UCHAR *pData, UINT32 ulBytes);
  96.     
  97.     ///////////////////////////////////////////////////////////////////////////
  98.     // Function:    AdvanceRead
  99.     // Purpose:     Advances the read pointer in the buffer handling wrapping.
  100.     // Params:      ulBytes is number of bytes to advance the read pointer
  101.     // Author:      cts
  102.     ///////////////////////////////////////////////////////////////////////////
  103.     void    AdvanceRead(UINT32 ulBytes);
  104.     ///////////////////////////////////////////////////////////////////////////
  105.     // Function:    DecrementRead
  106.     // Purpose:     Decrements the read pointer in the buffer.
  107.     // Params:      ulBytes is number of bytes to decrement the read pointer
  108.     // Author:      cts
  109.     ///////////////////////////////////////////////////////////////////////////
  110.     void    DecrementRead(UINT32 ulBytes);
  111.     ///////////////////////////////////////////////////////////////////////////
  112.     // Function:    GetReadPointer
  113.     // Purpose:     Gives Access to data by supplying the read pointer and
  114.     //              its size.  Its size denotes how many bytes until the end
  115.     //              of the buffer.
  116.     // Params:      ulBytes will be the size of the read pointer
  117.     // Returns:     The read pointer
  118.     // Author:      cts
  119.     ///////////////////////////////////////////////////////////////////////////
  120.     UCHAR*  GetReadPointer(UINT32 &ulBytes);
  121.     ///////////////////////////////////////////////////////////////////////////
  122.     // Function:    Wrap
  123.     // Purpose:     Move the data from the current read postion to the wrap
  124.     //              area before the buffer and set the read pointer to that
  125.     //              position.
  126.     //
  127.     // Params:      nOldBytes is the amount of bytes before your current read
  128.     //              pointer you want to preserve in the wrap.
  129.     // Author:      cts
  130.     ///////////////////////////////////////////////////////////////////////////
  131.     void    Wrap(UINT32 ulOldBytes=0);
  132.     // Status functions
  133.     HX_RESULT   GetError()          {return m_ulError;}
  134.     UINT32  GetBytesWritten()       {return m_ulBytesWritten;}
  135.     UINT32  GetBytesRead()          {return m_ulBytesRead;}
  136.     UINT32  GetBufferSize()         {return m_ulBufSize;}
  137.     UINT32  GetGuardSize()          {return m_ulGuardSize;}
  138.     
  139.     UINT32  GetBytesInBuffer()      {return m_ulBytesWritten - m_ulBytesRead;}
  140.     UINT32  GetFreeBufferSpace()    {return m_ulBufSize - GetBytesInBuffer();}
  141.     UINT32  GetPrevBytes()          {return m_ulRead - m_ulVBufBegin;}
  142. private:
  143.     LONG32      m_lRefCount;
  144.     UCHAR       *m_pBuffer;
  145.     union       {UCHAR *m_pBufBegin; PTR_INT m_ulBufBegin;};
  146.     union       {UCHAR *m_pBufEnd;   PTR_INT m_ulBufEnd;};
  147.     union       {UCHAR *m_pWrite;    PTR_INT m_ulWrite;};
  148.     union       {UCHAR *m_pRead;     PTR_INT m_ulRead;};
  149.     union       {UCHAR *m_pVBufBegin;PTR_INT m_ulVBufBegin;};
  150.     UINT32      m_ulBytesWritten,
  151.                 m_ulBytesRead,
  152.                 m_ulBufSize,
  153.                 m_ulGuardSize;
  154.     IHXBuffer  *m_pIhxBuffer;
  155.     HX_RESULT   m_ulError;
  156. };
  157. #endif