diff options
Diffstat (limited to 'lf_ringbuffer.h')
-rw-r--r-- | lf_ringbuffer.h | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/lf_ringbuffer.h b/lf_ringbuffer.h new file mode 100644 index 0000000..2266ba2 --- /dev/null +++ b/lf_ringbuffer.h @@ -0,0 +1,73 @@ +/* + * File : lf_ring_buffer.h + * Author : Jérémy Zurcher <jeremy@asynk.ch> + * Date : 05/01/010 + * License : + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * + */ + +#ifndef _LF_RING_BUFFER_H_ +#define _LF_RING_BUFFER_H_ + +# ifdef __cplusplus +extern "C" { +# endif /* __cplusplus */ + +#include <sys/types.h> +#include "lf_ringbuffer_data.h" + +#define LFRB_NO_BLOCK 1 /* if buffer is full, leave instead of try again and again */ +#define IS_NOT_BLOCKING( flags ) ( (flags)&LFRB_NO_BLOCK ) + +/* the ring buffer structure */ +typedef struct ring_buffer { + LFRB_BUFFER_TYPE *buffer; /* buffer data */ + size_t n_buf; /* number of buffers, max 65534, see implementation for details */ + unsigned int indexes; /* indexes where to read_from and write_to */ +} lf_ring_buffer_t; + +/* return an initialized lf_ring_buffer_t struct, size is limited to 65534, see implementation for details */ +lf_ring_buffer_t* lf_ring_buffer_create( size_t n_buf ); + +/* destroy an lf_ring_buffer_t struct */ +void lf_ring_buffer_destroy( lf_ring_buffer_t *r ); + +/* return 1 if is empty */ +int lf_ring_buffer_empty( lf_ring_buffer_t *r ); + +/* write data into the ring buffer + * return 0 on success + * return -1 if IS_NOT_BLOCKING and buffer is full + */ +int lf_ring_buffer_write( lf_ring_buffer_t *r, void *data, int flags ); + +/* read data from the ring buffer + * return 0 on success + * return -1 if IS_NOT_BLOCKING and buffer is empty + */ +int lf_ring_buffer_read( lf_ring_buffer_t *r, void *data, int flags ); + +# ifdef __cplusplus +} +# endif /* __cplusplus */ + +# endif /* _LF_RING_BUFFER_H_ */ |