当前位置:   article > 正文

记录 队列数据缓冲区(FiFoBuffer)_fifo buffer

fifo buffer

说明

实际开发中,数据缓存区的概念是必须了解的。如经典的生产、消费模型就是维持着一块数据缓存区供相关的读写操作,当然线程安全问题跑不掉。这里记录下工作中经常使用且经过长时间检验的缓冲区代码,绝大部分场景完全满足,复制直接可用。
还有比较经典的环形缓存等设计方法,基本原理比较相似,但很难有万能、全面的方法设计,能兼顾稳定性、简洁性就是好的设计,应用场景不同,取长补短就好。有一点注意的是,任何缓冲区的读写速度都不应该相差太大,比如写的很快,读的很慢,那么必然缓存区需要很大(即使能自动扩充大小),这种是业务逻辑设计要做的事(避免或降低二者速度差距),完全让缓存区来解决是不合理的,生产和消费能力动态平衡是比较理想的状态。

原理

此缓冲区的设计思路,如下图。此缓冲区特点是:

  1. 分块节点形式写入。如依次写入5次大小不同的数据,可以通过不断调用popData依次拿到单独的每次数据,不需要再做区分。
  2. 单次拷贝。只需要写入缓存区时进行一次拷贝,读数据时利用内部节点记录的数据块始末指针,不需要再拷贝数据出来。

同样缺点是:

  1. 依次写入两次100字节的数据,共200字节。若读取150字节,就需要加额外的逻辑处理。
  2. 末尾可能存在未使用的空间, 但简化了逻辑处理增强的稳定性,有舍有得吧。

缓冲区原理

代码

直接上代码,看代码理解就好,并不是很难,已经封装成了类。

  1. 头文件 fifobuffer.h
#ifndef FIFOBUFFER_H
#define FIFOBUFFER_H

#include <list>
#include <mutex>

//数据节点
struct DataNode
{
    DataNode()
    {
        begin = 0;
        end = 0;
    }

    //记录当前数据块的始、末位置
    int begin;
    int end;
};

//缓冲区类 实现队列存储数据块 只拷贝一次,提供给外部使用
class FiFoBuffer
{
public:
    FiFoBuffer();
    ~FiFoBuffer();

    //初始化缓冲区
    bool initFiFoBuffer(int bufferLength);
    //释放缓冲区
    void freeFiFoBuffer();
    //重置缓冲区(不需要重新申请内存)
    void resetFiFoBuffer();

    //获取当前的数据块节点数量
    int getDataNodeSize();
    //获取缓冲区总长度
    int getFiFoBufferLength();
    //获取缓冲区剩余空间大小
    int getRemainSapce();

    //数据写入缓冲区尾部 注:缓存区满则写入失败
    bool pushData(char *data, int length);
    //返回缓冲区头部数据及长度供外部使用 需要popDelete来释放此数据块空间
    char *popData(int *length);
    //调用此函数删除头部数据块
    bool popDelete();

private:
    //线程安全锁
    std::mutex fifoMutex;

    //缓冲区相关变量
    char *fifoBuffer;
    int fifoBufferLength;
    int fifoBegin;
    int fifoEnd;

    //数据块节点
    std::list<DataNode> dataNodeList;
};

#endif // FIFOBUFFER_H
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  1. 实现文件 fifobuffer.cpp
#include "fifobuffer.h"

FiFoBuffer::FiFoBuffer()
{
    fifoBuffer = nullptr;
    fifoBufferLength = 0;
    fifoBegin = 0;
    fifoEnd = 0;
}

FiFoBuffer::~FiFoBuffer()
{
    freeFiFoBuffer();
}

bool FiFoBuffer::initFiFoBuffer(int bufferLength)
{
    if(bufferLength < 0)
        return false;

    std::lock_guard<std::mutex> lock(fifoMutex);
    if (fifoBuffer != nullptr)
        return false;

    fifoBuffer = new char[bufferLength];
    if(fifoBuffer == nullptr)
        return false;

    fifoBufferLength = bufferLength;
    memset(fifoBuffer, 0, fifoBufferLength);

    fifoBegin = 0;
    fifoEnd = 0;
    dataNodeList.clear();
    return true;
}

void FiFoBuffer::freeFiFoBuffer()
{
    std::lock_guard<std::mutex> lock(fifoMutex);
    fifoBegin = 0;
    fifoEnd = 0;
    fifoBufferLength = 0;
    dataNodeList.clear();

    if (fifoBuffer != nullptr)
    {
        delete[] fifoBuffer;
        fifoBuffer = NULL;
    }
}

void FiFoBuffer::resetFiFoBuffer()
{
    std::lock_guard<std::mutex> lock(fifoMutex);
    fifoBegin = 0;
    fifoEnd = 0;
    dataNodeList.clear();
    memset(fifoBuffer, 0, fifoBufferLength);
}

int FiFoBuffer::getDataNodeSize()
{
    std::lock_guard<std::mutex> lock(fifoMutex);
    return dataNodeList.size();
}

int FiFoBuffer::getFiFoBufferLength()
{
    std::lock_guard<std::mutex> lock(fifoMutex);
    return fifoBufferLength;
}

int FiFoBuffer::getRemainSapce()
{
    std::lock_guard<std::mutex> lock(fifoMutex);
    if (fifoBufferLength <= 0)
        return fifoBufferLength;

    if (dataNodeList.size() <= 0)
        return fifoBufferLength;

    int listLengthCount = 0;
    std::list<DataNode>::iterator it;
    for (it = dataNodeList.begin(); it != dataNodeList.end(); ++it)
    {
        DataNode node = *it;
        listLengthCount += node.end - node.begin;
    }

    return  fifoBufferLength - listLengthCount;
}

bool FiFoBuffer::pushData(char *data, int length)
{
    std::lock_guard<std::mutex> lock(fifoMutex);

    //条件判断
    if (fifoBufferLength <= 0 || fifoBuffer == NULL || data == NULL || length <= 0 || length > fifoBufferLength)
        return false;

    //检测剩余的空间是否够存储 不够则重头开始存储
    if (fifoBufferLength - fifoEnd < length)
        fifoEnd = 0;

    if (dataNodeList.size() > 0)
    {
        int nStart = 0;
        DataNode nodeFront = dataNodeList.front();
        nStart = nodeFront.begin;

        if (fifoEnd == 0)
        {
            //是否可以重头开始
            if (nStart < length)
                return false;
        }
        else
        {
            if (nStart >= fifoEnd)
            {
                //剩余空间不够
                if ((nStart - fifoEnd) < length)
                    return false;
            }
            else
            {
                //剩余空间不够
                if (fifoBufferLength - fifoEnd < length)
                    return false;
            }
        }
    }

    //记录新的数据块
    DataNode node;
    node.begin = fifoEnd;
    node.end = node.begin + length;
    dataNodeList.push_back(node);

    memcpy(fifoBuffer + fifoEnd, data, length);
    fifoEnd += length;
    return true;
}

char *FiFoBuffer::popData(int *length)
{
    std::lock_guard<std::mutex> lock(fifoMutex);

    char *buffer = nullptr;
    if (dataNodeList.size() <= 0)
    {
        *length = 0;
        return buffer;
    }

    DataNode node;
    node = dataNodeList.front();

    //为了稳定性再次判断返回的节点是否有效
    int offset = node.end - node.begin;
    if (node.begin >= 0 &&
        node.end > 0 &&
        node.begin < fifoBufferLength &&
        node.end <= fifoBufferLength &&
        offset > 0 &&
        offset <= fifoBufferLength)
    {
        buffer = fifoBuffer + node.begin;
        *length = offset;
        return buffer;
    }
    else
    {
        buffer = NULL;
        *length = 0;
        return buffer;
    }
}

bool FiFoBuffer::popDelete()
{
    std::lock_guard<std::mutex> lock(fifoMutex);

    if (dataNodeList.size() <= 0)
        return false;

    //删除数据块记录即可,表示该数据块区域可被再次使用
    dataNodeList.pop_front();
    if (dataNodeList.size() <= 0)
    {
        fifoBegin = 0;
        fifoEnd = 0;
    }

    return true;
}

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/Cpp五条/article/detail/601684
推荐阅读
相关标签
  

闽ICP备14008679号