Firmware
Public Member Functions | List of all members
__EXPORT::RingBuffer Class Reference

Public Member Functions

 RingBuffer (unsigned num_items, size_t item_size)
 
bool put (const void *val, size_t val_size=0)
 Put an item into the buffer. More...
 
bool put (int8_t val)
 
bool put (uint8_t val)
 
bool put (int16_t val)
 
bool put (uint16_t val)
 
bool put (int32_t val)
 
bool put (uint32_t val)
 
bool put (int64_t val)
 
bool put (uint64_t val)
 
bool put (float val)
 
bool put (double val)
 
bool force (const void *val, size_t val_size=0)
 Force an item into the buffer, discarding an older item if there is not space. More...
 
bool force (int8_t val)
 
bool force (uint8_t val)
 
bool force (int16_t val)
 
bool force (uint16_t val)
 
bool force (int32_t val)
 
bool force (uint32_t val)
 
bool force (int64_t val)
 
bool force (uint64_t val)
 
bool force (float val)
 
bool force (double val)
 
bool get (void *val, size_t val_size=0)
 Get an item from the buffer. More...
 
bool get (int8_t &val)
 
bool get (uint8_t &val)
 
bool get (int16_t &val)
 
bool get (uint16_t &val)
 
bool get (int32_t &val)
 
bool get (uint32_t &val)
 
bool get (int64_t &val)
 
bool get (uint64_t &val)
 
bool get (float &val)
 
bool get (double &val)
 
unsigned space (void)
 
unsigned count (void)
 
bool empty ()
 
bool full ()
 
unsigned size ()
 
void flush ()
 
bool resize (unsigned new_size)
 
void print_info (const char *name)
 

Member Function Documentation

§ force()

bool __EXPORT::RingBuffer::force ( const void *  val,
size_t  val_size = 0 
)

Force an item into the buffer, discarding an older item if there is not space.

Parameters
valItem to put
Returns
true if an item was discarded to make space

§ get()

bool __EXPORT::RingBuffer::get ( void *  val,
size_t  val_size = 0 
)

Get an item from the buffer.

Parameters
valItem that was gotten
Returns
true if an item was got, false if the buffer was empty.

§ put()

bool __EXPORT::RingBuffer::put ( const void *  val,
size_t  val_size = 0 
)

Put an item into the buffer.

Parameters
valItem to put
Returns
true if the item was put, false if the buffer is full
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.12