cs_CharacteristicBuffer.h

Go to the documentation of this file.

/*
 * Author: Crownstone Team
 * Copyright: Crownstone (https://crownstone.rocks)
 * Date: Apr 2, 2015
 * License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
 */
#pragma once
 
#include <structs/cs_PacketsInternal.h>
 
#define CS_CHAR_BUFFER_DEFAULT_OFFSET 8
 
class CharacteristicBuffer {
 
protected:
    buffer_ptr_t _buffer   = nullptr;
    cs_buffer_size_t _size = 0;
    bool _locked           = false;
 
    CharacteristicBuffer();
    ~CharacteristicBuffer();
 
    CharacteristicBuffer(CharacteristicBuffer const&)            = delete;
 
    CharacteristicBuffer& operator=(CharacteristicBuffer const&) = delete;
 
public:
    void alloc(cs_buffer_size_t size);
 
    void clear();
 
    bool lock();
 
    bool unlock();
 
    bool isLocked();
 
    cs_data_t getBuffer(cs_buffer_size_t offset = CS_CHAR_BUFFER_DEFAULT_OFFSET);
 
    void getBuffer(buffer_ptr_t& buffer, uint16_t& size, cs_buffer_size_t offset = CS_CHAR_BUFFER_DEFAULT_OFFSET);
 
    cs_buffer_size_t size(cs_buffer_size_t offset = CS_CHAR_BUFFER_DEFAULT_OFFSET);
};