From 263178fbb653703273ca3684f16de0ee185f0ae1 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 29 Aug 2010 07:49:36 +0000 Subject: Add better description of the Ultra-Lightweight Ring Buffer header files. --- Projects/Benito/Lib/LightweightRingBuff.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'Projects/Benito') diff --git a/Projects/Benito/Lib/LightweightRingBuff.h b/Projects/Benito/Lib/LightweightRingBuff.h index cb0f6112a..768e49a50 100644 --- a/Projects/Benito/Lib/LightweightRingBuff.h +++ b/Projects/Benito/Lib/LightweightRingBuff.h @@ -30,7 +30,14 @@ /** \file * - * Ultra lightweight ring buffer, for fast insertion/deletion. + * Ultra lightweight ring buffer, for fast insertion/deletion. This uses inlined functions + * for maximum speed. All buffers created with this library must be of the same size, however + * multiple independant buffers can be created. + * + * Note that for each buffer, insertion and removal operations may occur at the same time (via + * a multithreaded ISR based system) however the same kind of operation (two or more insertions + * or deletions) must not overlap. If there is possibility of two or more of the same kind of + * operating occuring at the same point in time, atomic (mutex) locking should be used. */ #ifndef _ULW_RING_BUFF_H_ -- cgit v1.2.3