anderskaloer / ring-buffer Goto Github PK

  ring_buffer_t ring_buffer;
  char buf_arr[16];
  ring_buffer_init(&ring_buffer, buf_arr, sizeof(buf_arr));

  assert(ring_buffer_num_items(&ring_buffer) == 0);
    
  /* Add elements to buffer; one at a time */
  for(i = 0; i < 16; i++) {
    ring_buffer_queue(&ring_buffer, i);
  }

  /* Verify size */  
  assert(ring_buffer_num_items(&ring_buffer) == 16);

bool ring_buffer_read(ring_buffer_t *buffer, uint8_t *data) {
  ring_buffer_size_t tail_index = buffer->tail_index;
  ring_buffer_size_t head_index = buffer->head_index;

  if (tail_index == head_index) {
    /* No items */
    return false;
  }
  
  *data = buffer->buffer[tail_index];
  buffer->tail_index = ((tail_index + 1) & RING_BUFFER_MASK(buffer));
  return true;
}

void ring_buffer_write(ring_buffer_t *buffer, uint8_t data) {
  ring_buffer_size_t tail_index = buffer->tail_index;
  ring_buffer_size_t head_index = buffer->head_index;

  /* Is buffer full? */
  if (((head_index - tail_index) & RING_BUFFER_MASK(buffer)) == RING_BUFFER_MASK(buffer)) {
    return;
  }

  /* Place data in buffer */
  buffer->buffer[head_index] = data;
  buffer->head_index = ((head_index + 1) & RING_BUFFER_MASK(buffer));
}

 I am very interested in this demo。I tried to go through "Readme"for more details,but nothing in it。  
Enrich the content of the document so that more readers learn more。
A great demo.