roo_io::RingBuffer Class Reference

#include <ringbuffer.h>

Public Member Functions
	RingBuffer (size_t capacity)
size_t	capacity () const
size_t	used () const
size_t	free () const
bool	full () const
bool	empty () const
void	clear ()
size_t	write (const byte *data, size_t len)
bool	write (byte b)
bool	read (byte *b)
size_t	read (byte *data, size_t len)

Detailed Description

Definition at line 10 of file ringbuffer.h.

Constructor & Destructor Documentation

RingBuffer()

roo_io::RingBuffer::RingBuffer ( size_t  capacity )

inline

Definition at line 12 of file ringbuffer.h.

Member Function Documentation

capacity()

size_t roo_io::RingBuffer::capacity ( ) const

inline

Definition at line 15 of file ringbuffer.h.

clear()

void roo_io::RingBuffer::clear ( )

inline

Definition at line 22 of file ringbuffer.h.

Referenced by roo_io::RingPipe::closeInput().

empty()

bool roo_io::RingBuffer::empty ( ) const

inline

Definition at line 20 of file ringbuffer.h.

Referenced by roo_io::RingPipe::inputStatus(), roo_io::RingPipe::read(), and roo_io::RingPipe::tryRead().

free()

size_t roo_io::RingBuffer::free ( ) const

inline

Definition at line 17 of file ringbuffer.h.

Referenced by roo_io::RingPipe::availableForWrite(), and write().

full()

bool roo_io::RingBuffer::full ( ) const

inline

Definition at line 19 of file ringbuffer.h.

Referenced by roo_io::RingPipe::tryWrite(), and roo_io::RingPipe::write().

read() [1/2]

bool roo_io::RingBuffer::read ( byte *  b )

inline

Definition at line 58 of file ringbuffer.h.

Referenced by roo_io::RingPipe::read(), and roo_io::RingPipe::tryRead().

read() [2/2]

size_t roo_io::RingBuffer::read ( byte *  data, size_t  len  )

inline

Definition at line 69 of file ringbuffer.h.

used()

size_t roo_io::RingBuffer::used ( ) const

inline

Definition at line 16 of file ringbuffer.h.

Referenced by roo_io::RingPipe::availableForRead().

write() [1/2]

bool roo_io::RingBuffer::write ( byte  b )

inline

Definition at line 49 of file ringbuffer.h.

write() [2/2]

size_t roo_io::RingBuffer::write ( const byte *  data, size_t  len  )

inline

Definition at line 29 of file ringbuffer.h.

References free().

Referenced by roo_io::RingPipe::tryWrite(), and roo_io::RingPipe::write().

---

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

• temp_repos/roo_io/src/roo_io/ringpipe/ringbuffer.h