StateOS
Loading...
Searching...
No Matches
stateos::RawBufferT< limit_ > Struct Template Reference

create and initialize a raw buffer object More...

#include <osrawbuffer.h>

Inheritance diagram for stateos::RawBufferT< limit_ >:

Public Types

using Ptr = std::unique_ptr<RawBufferT<limit_>>
 result type of Create()

Public Member Functions

constexpr RawBufferT ()
 constructor, see the constructor parameters of the class
 RawBufferT (RawBufferT &&_src)
 move constructor
 RawBufferT (const RawBufferT &)=delete
RawBufferT & operator= (RawBufferT &&)=delete
RawBufferT & operator= (const RawBufferT &)=delete
void reset ()
 raw_reset()
void kill ()
 raw_kill()
void destroy ()
 raw_destroy()
int take (void *_data, size_t _size, size_t *_read=nullptr)
 raw_take()
int tryWait (void *_data, size_t _size, size_t *_read=nullptr)
 raw_tryWait()
int takeISR (void *_data, size_t _size, size_t *_read=nullptr)
 raw_takeISR()
template<typename T>
int waitFor (void *_data, size_t _size, size_t *_read, const T &_delay)
 raw_waitFor()
template<typename T>
int waitUntil (void *_data, size_t _size, size_t *_read, const T &_time)
 raw_waitUntil()
int wait (void *_data, size_t _size, size_t *_read=nullptr)
 raw_wait()
int give (const void *_data, size_t _size)
 raw_give()
int giveISR (const void *_data, size_t _size)
 raw_giveISR()
template<typename T>
int sendFor (const void *_data, size_t _size, const T &_delay)
 raw_sendFor()
template<typename T>
int sendUntil (const void *_data, size_t _size, const T &_time)
 raw_sendUntil()
int send (const void *_data, size_t _size)
 raw_send()
int push (const void *_data, size_t _size)
 raw_push()
int pushISR (const void *_data, size_t _size)
 raw_pushISR()
size_t count ()
 raw_count()
size_t countISR ()
 raw_countISR()
size_t space ()
 raw_space()
size_t spaceISR ()
 raw_spaceISR()
size_t limit ()
 raw_limit()
size_t limitISR ()
 raw_limitISR()

Static Public Member Functions

static Ptr Create ()
 create dynamic object with manageable resources

Detailed Description

template<size_t limit_>
struct stateos::RawBufferT< limit_ >

create and initialize a raw buffer object

Constructor parameters
  • limit: size of a buffer (max number of stored bytes)

Member Function Documentation

◆ Create()

template<size_t limit_>
Ptr stateos::RawBufferT< limit_ >::Create ( )
inlinestatic

create dynamic object with manageable resources

Parameters
  • limit: size of a buffer (max number of stored bytes)
Returns
std::unique_pointer / pointer to RawBufferT<> object
Note
use only in thread mode

The documentation for this struct was generated from the following file: