StateOS
Loading...
Searching...
No Matches
stateos::MemoryPoolT< limit_, size_ > Struct Template Reference

create and initialize a memory pool object More...

#include <osmemorypool.h>

Inheritance diagram for stateos::MemoryPoolT< limit_, size_ >:

Public Types

using Ptr = std::unique_ptr<MemoryPoolT<limit_, size_>>
 result type of Create()

Public Member Functions

 MemoryPoolT ()
 constructor, see the constructor parameters of the class
 MemoryPoolT (MemoryPoolT &&_src)
 move constructor
 MemoryPoolT (const MemoryPoolT &)=delete
MemoryPoolT & operator= (MemoryPoolT &&)=delete
MemoryPoolT & operator= (const MemoryPoolT &)=delete
void reset ()
 mem_reset()
void kill ()
 mem_kill()
void destroy ()
 mem_destroy()
int take (void **_data)
 mem_take()
int tryWait (void **_data)
 mem_tryWait()
int takeISR (void **_data)
 mem_takeISR()
template<typename T>
int waitFor (void **_data, const T &_delay)
 mem_waitFor()
template<typename T>
int waitUntil (void **_data, const T &_time)
 mem_waitUntil()
int wait (void **_data)
 mem_wait()
void give (void *_data)
 mem_give()
void giveISR (void *_data)
 mem_giveISR()

Static Public Member Functions

static Ptr Create ()
 create dynamic object with manageable resources

Detailed Description

template<unsigned limit_, size_t size_>
struct stateos::MemoryPoolT< limit_, size_ >

create and initialize a memory pool object

Constructor parameters
  • limit: size of a buffer (max number of objects)
  • size: size of memory object (in bytes)

Member Function Documentation

◆ Create()

template<unsigned limit_, size_t size_>
Ptr stateos::MemoryPoolT< limit_, size_ >::Create ( )
inlinestatic

create dynamic object with manageable resources

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

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