File content as of revision 53:7b65422d7a32:

/**
   @file
   @brief Class to decode and store received data frames in a circular
           buffer
      
   @author John Bailey 

   @copyright Copyright 2014 John Bailey

   @section LICENSE
   
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

*/

#if !defined XBEEAPIRXFRAMECIRCULARBUFFER_HPP
#define      XBEEAPIRXFRAMECIRCULARBUFFER_HPP

#include "XBeeApiRxFrameDecoder.hpp"
#include "XBeeDevice.hpp"

#include <stdint.h>

/** Class to deal with decoding of an RX'd data frame
*/
class XBeeApiRxFrameCircularBuffer : public XBeeApiRxFrameDecoder
{
    protected:
        /* TODO: doc */
        size_t          m_bufferSize;
        /* TODO: doc */
        size_t          m_head;
        /* TODO: doc */
        size_t          m_tail; 
        /* TODO: doc */
        size_t          m_count;
        /* TODO: doc */
        XBeeApiRxFrame* m_framesBuffer;

    public:
        /* TODO: doc */
        /** Constructor */
        XBeeApiRxFrameCircularBuffer( size_t p_bufferSize, XBeeDevice* p_device = NULL );
        
        /** Destructor */
        virtual ~XBeeApiRxFrameCircularBuffer( void ); 

        /* Callback which is invoked when a frame is successfully decoded
           \param p_frame The frame content
        */       
        virtual void frameRxCallback( XBeeApiRxFrame* p_frame );

        /* TODO: doc */
        size_t getFrameCount() const;

        /* TODO: doc */
        void clear();

        /* TODO: doc */
        void pop();

        /* TODO: doc */
        const XBeeApiRxFrame* getTailPtr() const;
};

#endif