log_backend_ringbuf.h File Reference

Go to the source code of this file.

Functions
int	log_backend_ringbuf_get_claim (uint8_t **data, size_t length)
int	log_backend_ringbuf_finish_claim (size_t length)
void	log_backend_ringbuf_clear (void)
size_t	log_backend_ringbuf_get_used (void)

Function Documentation

log_backend_ringbuf_clear()

void log_backend_ringbuf_clear

(

void

)

Clear the ring buffer log backend. Resets the ring buffer to empty, so new log messages will be written

log_backend_ringbuf_finish_claim()

int log_backend_ringbuf_finish_claim

(

size_t

length

)

Finish claiming data from the ring buffer log backend. internally calls ring_buf_get_finish() on the logging ring buffer.

Parameters

length

Number of bytes read from the buffer.

Returns

0 on success, negative error code on failure.

log_backend_ringbuf_get_claim()

int log_backend_ringbuf_get_claim	(	uint8_t **	data,
		size_t	length )

Get address of ring buffer log backend buffer. internally calls ring_buf_get_claim() on the logging ring buffer.

Parameters

data	Pointer to address. Will be set to location within ring buffer
length	Requested length of data to claim

Returns

Number of valid bytes claimed. May be less than requested length.

log_backend_ringbuf_get_used()

size_t log_backend_ringbuf_get_used

(

void

)

Get the number of bytes currently stored in the ring buffer log backend.

Returns

Number of bytes currently stored in the ring buffer