Skip to content

Class cbuf

ClassList > cbuf

Public Attributes

Type Name
cbuf * next

Public Functions

Type Name
size_t available () const
cbuf (size_t size)
bool empty () const
void flush ()
bool full () const
int peek ()
size_t peek (char * dst, size_t size)
int read ()
size_t read (char * dst, size_t size)
size_t remove (size_t size)
size_t resize (size_t newSize)
size_t resizeAdd (size_t addSize)
size_t room () const
size_t size ()
size_t write (char c)
size_t write (const char * src, size_t size)
~cbuf ()

Protected Attributes

Type Name
char * _begin
char * _buf
const char * _bufend
char * _end
size_t _size

Protected Functions

Type Name
char * wrap_if_bufend (char * ptr) const

Public Attributes Documentation

variable next

cbuf* cbuf::next;

Public Functions Documentation

function available

size_t cbuf::available () const

function cbuf

cbuf::cbuf (
    size_t size

function empty

inline bool cbuf::empty () const

function flush

void cbuf::flush () 

function full

inline bool cbuf::full () const

function peek [1/2]

int cbuf::peek () 

function peek [2/2]

size_t cbuf::peek (
    char * dst,
    size_t size

function read [1/2]

int cbuf::read () 

function read [2/2]

size_t cbuf::read (
    char * dst,
    size_t size

function remove

size_t cbuf::remove (
    size_t size

function resize

size_t cbuf::resize (
    size_t newSize

function resizeAdd

size_t cbuf::resizeAdd (
    size_t addSize

function room

size_t cbuf::room () const

function size

size_t cbuf::size () 

function write [1/2]

size_t cbuf::write (
    char c

function write [2/2]

size_t cbuf::write (
    const char * src,
    size_t size

function ~cbuf

cbuf::~cbuf () 

Protected Attributes Documentation

variable _begin

char* cbuf::_begin;

variable _buf

char* cbuf::_buf;

variable _bufend

const char* cbuf::_bufend;

variable _end

char* cbuf::_end;

variable _size

size_t cbuf::_size;

Protected Functions Documentation

function wrap_if_bufend

inline char * cbuf::wrap_if_bufend (
    char * ptr
) const

The documentation for this class was generated from the following file cores/common/arduino/libraries/ext/cbuf/cbuf.h