LUFA Library  120730
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages

Ring Buffer Management Structure. More...

#include <RingBuffer.h>

Data Fields

uint8_t * In
uint8_t * Out
uint8_t * Start
uint8_t * End
uint16_t Size
uint16_t Count

Detailed Description

Type define for a new ring buffer object. Buffers should be initialized via a call to RingBuffer_InitBuffer() before use.

Field Documentation

uint16_t RingBuffer_t::Count

Number of bytes currently stored in the buffer.

uint8_t* RingBuffer_t::End

Pointer to the end of the buffer's underlying storage array.

uint8_t* RingBuffer_t::In

Current storage location in the circular buffer.

uint8_t* RingBuffer_t::Out

Current retrieval location in the circular buffer.

uint16_t RingBuffer_t::Size

Size of the buffer's underlying storage array.

uint8_t* RingBuffer_t::Start

Pointer to the start of the buffer's underlying storage array.


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