esp_ringbuf.h File Reference

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>

Go to the source code of this file.

Macros
#define	__VSF_ESPIDF_FREERTOS_TYPES_DEFINED__
#define	pdTRUE   ((BaseType_t)1)
#define	pdFALSE   ((BaseType_t)0)
#define	pdPASS   pdTRUE
#define	pdFAIL   pdFALSE
#define	portMAX_DELAY   ((TickType_t)0xFFFFFFFFu)

Typedefs
typedef long	BaseType_t
typedef uint32_t	TickType_t
typedef struct __vsf_espidf_ringbuf *	RingbufHandle_t

Enumerations
enum	RingbufferType_t {   RINGBUF_TYPE_NOSPLIT = 0 ,   RINGBUF_TYPE_ALLOWSPLIT = 1 ,   RINGBUF_TYPE_BYTEBUF = 2 }

Functions
RingbufHandle_t	xRingbufferCreate (size_t buffer_size, RingbufferType_t type)
void	vRingbufferDelete (RingbufHandle_t handle)
BaseType_t	xRingbufferSend (RingbufHandle_t handle, const void *data, size_t data_size, TickType_t ticks_to_wait)
void *	xRingbufferReceive (RingbufHandle_t handle, size_t *item_size, TickType_t ticks_to_wait)
void *	xRingbufferReceiveUpTo (RingbufHandle_t handle, size_t *item_size, TickType_t ticks_to_wait, size_t wanted_size)
void	vRingbufferReturnItem (RingbufHandle_t handle, void *item)
size_t	xRingbufferGetCurFreeSize (RingbufHandle_t handle)
size_t	xRingbufferGetCurFilledSize (RingbufHandle_t handle)
size_t	xRingbufferGetMaxItemSize (RingbufHandle_t handle)

Macro Definition Documentation

__VSF_ESPIDF_FREERTOS_TYPES_DEFINED__

#define __VSF_ESPIDF_FREERTOS_TYPES_DEFINED__

pdTRUE

#define pdTRUE   ((BaseType_t)1)

pdFALSE

#define pdFALSE   ((BaseType_t)0)

pdPASS

#define pdPASS   pdTRUE

pdFAIL

#define pdFAIL   pdFALSE

portMAX_DELAY

#define portMAX_DELAY   ((TickType_t)0xFFFFFFFFu)

Typedef Documentation

BaseType_t

typedef long BaseType_t

FreeRTOS portable signed word.

TickType_t

typedef uint32_t TickType_t

FreeRTOS tick counter type.

RingbufHandle_t

typedef struct __vsf_espidf_ringbuf* RingbufHandle_t

Enumeration Type Documentation

RingbufferType_t

enum RingbufferType_t

Enumerator
RINGBUF_TYPE_NOSPLIT	Item-oriented, no split at wrap
RINGBUF_TYPE_ALLOWSPLIT	Item-oriented, may wrap
RINGBUF_TYPE_BYTEBUF	Pure byte stream

Function Documentation

xRingbufferCreate()

RingbufHandle_t xRingbufferCreate	(	size_t	buffer_size,
		RingbufferType_t	type
	)

vRingbufferDelete()

void vRingbufferDelete

(

RingbufHandle_t

handle

)

xRingbufferSend()

BaseType_t xRingbufferSend	(	RingbufHandle_t	handle,
		const void *	data,
		size_t	data_size,
		TickType_t	ticks_to_wait
	)

xRingbufferReceive()

void * xRingbufferReceive	(	RingbufHandle_t	handle,
		size_t *	item_size,
		TickType_t	ticks_to_wait
	)

xRingbufferReceiveUpTo()

void * xRingbufferReceiveUpTo	(	RingbufHandle_t	handle,
		size_t *	item_size,
		TickType_t	ticks_to_wait,
		size_t	wanted_size
	)

vRingbufferReturnItem()

void vRingbufferReturnItem	(	RingbufHandle_t	handle,
		void *	item
	)

xRingbufferGetCurFreeSize()

size_t xRingbufferGetCurFreeSize

(

RingbufHandle_t

handle

)

xRingbufferGetCurFilledSize()

size_t xRingbufferGetCurFilledSize

(

RingbufHandle_t

handle

)

xRingbufferGetMaxItemSize()

size_t xRingbufferGetMaxItemSize

(

RingbufHandle_t

handle

)