cppnet_buffer.h

// Use of this source code is governed by a BSD 3-Clause License
// that can be found in the LICENSE file.

// Author: caozhiyi (caozhiyi5@gmail.com)

#ifndef INCLUDE_CPPNET_BUFFER
#define INCLUDE_CPPNET_BUFFER

#include <cstdint>

namespace cppnet {

class Buffer {
public:
    Buffer() = default;
    virtual ~Buffer() = default;

    // read to data to buf but don't move the read point.
    // return read size.
    virtual uint32_t ReadNotMovePt(char* buf, uint32_t buf_len) = 0;
    // read data to res buf and move the read point.
    // return read size.
    virtual uint32_t Read(char* res, uint32_t len) = 0;
    
    // clear all data
    virtual void Clear() = 0;

    // do not read when buffer less than len. 
    // return len when read otherwise return 0
    virtual uint32_t ReadUntil(char* res, uint32_t len) = 0;

    // move read point
    virtual int32_t MoveReadPt(int32_t len) = 0;
    
    // do not read when can't find specified character.
    // return read bytes when read otherwise return 0
    // when find specified character but res length is too short, 
    // return 0 and the last param return need length
    virtual uint32_t ReadUntil(char* res, uint32_t len, const char* find, uint32_t find_len, uint32_t& need_len) = 0;

    // return size of data that can be read
    virtual uint32_t GetCanReadLength() = 0;

    // return can read bytes
    virtual uint32_t FindStr(const char* s, uint32_t s_len) = 0;
};

} // namespace cppnet

#endif