"Fossies" - the Fresh Open Source Software Archive

Member "stud-0.3/ringbuffer.h" (2 Nov 2011, 2595 Bytes) of package /linux/privat/old/stud-0.3.tar.gz:

    1 /**
    2   * Copyright 2011 Bump Technologies, Inc. All rights reserved.
    3   *
    4   * Redistribution and use in source and binary forms, with or without modification, are
    5   * permitted provided that the following conditions are met:
    6   *
    7   *    1. Redistributions of source code must retain the above copyright notice, this list of
    8   *       conditions and the following disclaimer.
    9   *
   10   *    2. Redistributions in binary form must reproduce the above copyright notice, this list
   11   *       of conditions and the following disclaimer in the documentation and/or other materials
   12   *       provided with the distribution.
   13   *
   14   * THIS SOFTWARE IS PROVIDED BY BUMP TECHNOLOGIES, INC. ``AS IS'' AND ANY EXPRESS OR IMPLIED
   15   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
   16   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BUMP TECHNOLOGIES, INC. OR
   17   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   18   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
   19   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
   20   * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
   21   * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
   22   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   23   *
   24   * The views and conclusions contained in the software and documentation are those of the
   25   * authors and should not be interpreted as representing official policies, either expressed
   26   * or implied, of Bump Technologies, Inc.
   27   *
   28   **/
   29 
   30 #ifndef RINGBUFFER_H
   31 #define RINGBUFFER_H
   32 
   33 #include <stddef.h>
   34 
   35 /* Tweak these for potential memory/throughput tradeoffs */
   36 #define RING_SLOTS 3
   37 #define RING_DATA_LEN 1024 * 32
   38 
   39 typedef struct bufent {
   40     char data[RING_DATA_LEN];
   41     char *ptr;
   42     size_t left;
   43     struct bufent *next;
   44 } bufent;
   45 
   46 typedef struct ringbuffer {
   47     bufent slots[RING_SLOTS];
   48     bufent *head; // reads from the head
   49     bufent *tail; // writes to the tail
   50     size_t used;
   51 } ringbuffer;
   52 
   53 void ringbuffer_init(ringbuffer *rb);
   54 
   55 char * ringbuffer_read_next(ringbuffer *rb, int * length);
   56 void ringbuffer_read_skip(ringbuffer *rb, int length);
   57 void ringbuffer_read_pop(ringbuffer *rb);
   58 
   59 char * ringbuffer_write_ptr(ringbuffer *rb);
   60 void ringbuffer_write_append(ringbuffer *rb, int length);
   61 
   62 int ringbuffer_size(ringbuffer *rb);
   63 int ringbuffer_capacity(ringbuffer *rb);
   64 int ringbuffer_is_empty(ringbuffer *rb);
   65 int ringbuffer_is_full(ringbuffer *rb);
   66 
   67 #endif /* RINGBUFFER_H */