ringbuffer.h

Go to the documentation of this file.

 
#ifndef __RINGBUFFER_DECLARED
#define __RINGBUFFER_DECLARED
 
#include <stdint.h>
 
// Support for Windows DLL
#if __has_include(<windows.h>)
    #if defined(__RINGBUFFER_INTERNAL)
        #if defined(TEST_UNIT) || defined(TEST_INTEGRATION)
            #define LINKED_FUNCTION extern
        #else
            #define LINKED_FUNCTION extern __declspec (dllexport)
        #endif
    #else
        #define LINKED_FUNCTION __declspec (dllimport)
    #endif
#else // __has_include(<windows.h>)
    #define LINKED_FUNCTION extern
#endif // __has_include(<windows.h>)
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct ringbuffer_context;
 
typedef struct ringbuffer_context *ringbuffer_context_t;
 
LINKED_FUNCTION ringbuffer_context_t ringbuffer_init (
    void *target_array, const unsigned int element_size,
    const unsigned int element_count, const unsigned int initial_read_index,
    const unsigned int initial_write_index);
 
LINKED_FUNCTION void ringbuffer_read (ringbuffer_context_t context,
                                      void *pointer_to_output);
 
LINKED_FUNCTION void ringbuffer_write (ringbuffer_context_t context,
                                       const void *pointer_to_input);
 
LINKED_FUNCTION unsigned int
ringbuffer_get_read_index (const ringbuffer_context_t context);
 
LINKED_FUNCTION unsigned int
ringbuffer_get_write_index (const ringbuffer_context_t context);
 
LINKED_FUNCTION unsigned int
ringbuffer_is_empty (const ringbuffer_context_t context);
 
LINKED_FUNCTION void
ringbuffer_destroy (ringbuffer_context_t *pointer_to_context);
 
#ifdef __cplusplus
}
#endif
 
#undef LINKED_FUNCTION
 
#endif // __RINGBUFFER_DECLARED