Function CircularBuffer_Read

src/util/circular_buffer.c:171–202

read oldest item from buffer

// read oldest item from buffer
void *CircularBuffer_Read
(
	CircularBuffer cb,  // buffer to read item from
	void *item          // [optional] pointer populated with removed item
) {
	ASSERT(cb != NULL);

	// make sure there's data to return
	if(unlikely(CircularBuffer_Empty(cb))) {
		return NULL;
	}

	void *read = cb->read;

	// update buffer item count
	cb->item_count--;

	// copy item from buffer to output
	if(item != NULL) {
		memcpy(item, cb->read, cb->item_size);
	}

	// advance read position
	// circle back if read reached the end of the buffer
	cb->read += cb->item_size;
	if(unlikely(cb->read >= cb->end_marker)) {
		cb->read = cb->data;
	}

	// return original read position
	return read;
}

// free buffer (does not free its elements if its free callback is NULL)
void CircularBuffer_Free