diff options
Diffstat (limited to 'libnetdata/circular_buffer/README.md')
| -rw-r--r-- | libnetdata/circular_buffer/README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/libnetdata/circular_buffer/README.md b/libnetdata/circular_buffer/README.md new file mode 100644 index 0000000000..1917e22a65 --- /dev/null +++ b/libnetdata/circular_buffer/README.md @@ -0,0 +1,13 @@ +<!-- +-- +title: "circular_buffer" +custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/circular_buffer/README.md +--- +--> + +# Circular Buffer + +`struct circular_buffer` is an adaptive circular buffer. It will start at an initial size +and grow up to a maximum size as it fills. Two indices within the structure track the current +`read` and `write` position for data. + |