freertos_stream_buffer.hpp

Go to the documentation of this file.

 
#ifndef ELEC_C7222_UTILS_FREERTOS_STREAM_BUFFER_HPP
#define ELEC_C7222_UTILS_FREERTOS_STREAM_BUFFER_HPP
 
#include <cstddef>
#include <cstdint>
 
#include "non_copyable.hpp"
 
namespace c7222 {
 
class FreeRtosStreamBuffer : public NonCopyableNonMovable {
  public:
    FreeRtosStreamBuffer() = default;
    FreeRtosStreamBuffer(std::size_t buffer_size_bytes, std::size_t trigger_level_bytes);
    bool Initialize(std::size_t buffer_size_bytes, std::size_t trigger_level_bytes);
    ~FreeRtosStreamBuffer();
 
    std::size_t Send(const void* data, std::size_t data_length, std::uint32_t ticks_to_wait = 0);
    std::size_t SendFromISR(const void* data, std::size_t data_length);
    std::size_t Receive(void* out_data, std::size_t out_length, std::uint32_t ticks_to_wait = 0);
    std::size_t ReceiveFromISR(void* out_data, std::size_t out_length);
    bool Reset();
    std::size_t BytesAvailable() const;
    std::size_t SpacesAvailable() const;
    bool IsValid() const;
 
  private:
    void* handle_{nullptr};
};
 
class FreeRtosMessageBuffer : public NonCopyableNonMovable {
  public:
    FreeRtosMessageBuffer() = default;
    explicit FreeRtosMessageBuffer(std::size_t buffer_size_bytes);
    bool Initialize(std::size_t buffer_size_bytes);
    ~FreeRtosMessageBuffer();
 
    std::size_t Send(const void* message, std::size_t message_length, std::uint32_t ticks_to_wait = 0);
    std::size_t SendFromISR(const void* message, std::size_t message_length);
    std::size_t Receive(void* out_message, std::size_t out_length, std::uint32_t ticks_to_wait = 0);
    std::size_t ReceiveFromISR(void* out_message, std::size_t out_length);
    bool Reset();
    std::size_t SpacesAvailable() const;
    std::size_t NextMessageLength() const;
    bool IsValid() const;
 
  private:
    void* handle_{nullptr};
};
 
} // namespace c7222
 
#endif // ELEC_C7222_UTILS_FREERTOS_STREAM_BUFFER_HPP