GxP2PQueue.h

Go to the documentation of this file.

//===========================================================================
//===========================================================================
#pragma once
 
GX_P2P_NAMESPACE_BEGIN()
 
//===========================================================================
//===========================================================================
template <typename T, size_t N>
class GxP2PQueue
{
    //-----------------------------------------------------------
    //-----------------------------------------------------------
public:
    GxP2PQueue(void);
    virtual ~GxP2PQueue(void);
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
public:
    b32 queue(const T& input);
    b32 queue(GX_CSTR input, size_t size);
 
    b32 dequeue(T& output);
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
public:
    const void setOverWrite(b32 isOverWrite) { _isOverWrite = isOverWrite; }
    constexpr nu32 getQueueNum(void) const { return _num; }
#if GX_DEVELOP
    constexpr nu32 getMaxQueueNum(void) const { return _maxQueueNum; }
#endif  // GX_DEVELOP
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
protected:
    T                   _buffer[N];                             
    size_t              _bufferSize;                            
    nu32                _head;                                  
    nu32                _tail;                                  
    nu32                _num;                                   
    b32                 _isOverWrite;                           
#if GX_DEVELOP
    nu32                _maxQueueNum;                           
#endif  // GX_DEVELOP
 
};
 
//-------------------------------------------------------------------
// コンストラクタ
//-------------------------------------------------------------------
template <typename T, size_t N>
GxP2PQueue<T,N>::GxP2PQueue(void)
: _bufferSize(N)
, _head(0)
, _tail(0)
, _num(0)
, _isOverWrite(true)
#if GX_DEVELOP
, _maxQueueNum(0)
#endif  // GX_DEVELOP
{
    GX_MEMSET(_buffer, 0, sizeof(_buffer));
}
 
//-------------------------------------------------------------------
// デストラクタ
//-------------------------------------------------------------------
template <typename T, size_t N> 
GxP2PQueue<T,N>::~GxP2PQueue(void)
{
}
 
//-------------------------------------------------------------------
// キューに格納
//-------------------------------------------------------------------
template <typename T, size_t N>
b32 GxP2PQueue<T,N>::queue(const T& input)
{
    return queue(reinterpret_cast<GX_CSTR>(&input), sizeof(T));
}
 
//-------------------------------------------------------------------
// キューに格納
//-------------------------------------------------------------------
template <typename T, size_t N>
b32 GxP2PQueue<T,N>::queue(GX_CSTR input, size_t size)
{
    GXP2P_DEBUG_ASSERT(input, "input is nullptr\n");
    GXP2P_DEBUG_ASSERT(size <= sizeof(T), "QueueBuffer Overflow (size:%d > blockSize:%d)\n", size, sizeof(T));
 
    b32 result = true;
 
    // サイズ０ → 格納しない
    if( !size )
    {
        return true;
    }
 
    // バッファあふれ処理
    if( _num >= N )
    {
        if( !_isOverWrite )
        {
            // 上書きしない → そのまま終了
            return false;
        }
        else
        {
            // 上書きする → 一番古いデータを上書き
            result = false;                 // 返り値：FALSE
            dequeue(_buffer[_head]);        // 1つ取り出す (取り出し先は先頭)
        }
    }
 
    // キューに格納
    T* pFree = &_buffer[_tail];             // 空きバッファ取得
    GX_MEMCPY(pFree, input, size);
    
    // キューを進める
    ++ _num;
    ++ _tail;
    if( _tail >= N )
    {
        _tail = 0;
    }
 
#if GX_DEVELOP
    // キュー格納数最高到達点保持 (デバッグ用)
    if( _maxQueueNum < _num )
    {
        _maxQueueNum = _num;
        GXP2P_FUNCTION_PRINT("[%s] Queue Max Num Update (%d : max[%d])\n", _maxQueueNum, N);
    }
#endif  // GX_DEVELOP
 
    return result;
}
 
//-------------------------------------------------------------------
// キューから取得
//-------------------------------------------------------------------
template <typename T, size_t N>
b32 GxP2PQueue<T,N>::dequeue(T& output)
{
    // キューが空なら終了
    if( !_num )
    {
        return false;
    }
 
    // キューから出力先にコピー
    GX_MEMCPY(&output, &_buffer[_head], sizeof(T));
 
    // キューを減らす
    -- _num;
    ++ _head;
    if( _head >= N )
    {
        _head = 0;
    }
    
    return true;
}
 
GX_P2P_NAMESPACE_END()