AT&T ECOMP Vendor Event Listener library  0.1
Data Structures | Typedefs | Functions
ring_buffer.h File Reference

A ring buffer. More...

#include <pthread.h>
Include dependency graph for ring_buffer.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ring_buffer
 Ring buffer structure. More...
 

Typedefs

typedef struct ring_buffer ring_buffer
 Ring buffer structure. More...
 

Functions

void ring_buffer_initialize (ring_buffer *buffer, int size)
 Ring buffer initialization. More...
 
void * ring_buffer_read (ring_buffer *buffer)
 Read an element from a ring_buffer. More...
 
int ring_buffer_write (ring_buffer *buffer, void *msg)
 Write an element into a ring_buffer. More...
 
int ring_buffer_is_empty (ring_buffer *buffer)
 Tests whether there is data in the ring_buffer. More...
 

Detailed Description

A ring buffer.

License

Copyright(c) <2016>, AT&T Intellectual Property. All other rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. All advertising materials mentioning features or use of this software must display the following acknowledgement: This product includes software developed by the AT&T.
  4. Neither the name of AT&T nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY AT&T INTELLECTUAL PROPERTY ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL AT&T INTELLECTUAL PROPERTY BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file ring_buffer.h.

Typedef Documentation

§ ring_buffer

typedef struct ring_buffer ring_buffer

Ring buffer structure.

Function Documentation

§ ring_buffer_initialize()

void ring_buffer_initialize ( ring_buffer buffer,
int  size 
)

Ring buffer initialization.

Initialize the buffer supplied to the specified size.

Parameters
bufferPointer to the ring-buffer to be initialized.
sizeHow many elements to be stored in the ring-buffer.
Returns
Nothing

Definition at line 53 of file ring_buffer.c.

§ ring_buffer_is_empty()

int ring_buffer_is_empty ( ring_buffer buffer)

Tests whether there is data in the ring_buffer.

Tests whether there is currently data in the ring_buffer without blocking.

Parameters
bufferPointer to the ring-buffer to be tested.
Returns
Whether there is data in the ring_buffer.
Return values
0There isn't any data in the ring_buffer.
1There is data in the ring_buffer.

Definition at line 194 of file ring_buffer.c.

§ ring_buffer_read()

void* ring_buffer_read ( ring_buffer buffer)

Read an element from a ring_buffer.

Reads an element from the ring_buffer, advancing the next-read position. Operation is synchronized and therefore MT-safe. Blocks if no data is available.

Parameters
bufferPointer to the ring-buffer to be read.
Returns
Pointer to the element read from the buffer.

Definition at line 100 of file ring_buffer.c.

§ ring_buffer_write()

int ring_buffer_write ( ring_buffer buffer,
void *  msg 
)

Write an element into a ring_buffer.

Writes an element into the ring_buffer, advancing the next-write position. Operation is synchronized and therefore MT-safe. Fails if the buffer is full without blocking.

Parameters
bufferPointer to the ring-buffer to be written.
msgPointer to data to be stored in the ring_buffer.
Returns
Number of items written.
Return values
1The data was written successfully.
0The ring_buffer was full so no data written.

Definition at line 146 of file ring_buffer.c.