ring.h

Go to the documentation of this file.

/*
  Copyright 2011-2014 David Robillard <http://drobilla.net>
 
  Permission to use, copy, modify, and/or distribute this software for any
  purpose with or without fee is hereby granted, provided that the above
  copyright notice and this permission notice appear in all copies.
 
  THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
 
#ifndef ZIX_RING_H
#define ZIX_RING_H
 
#include <stdint.h>
 
#include "common.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct ZixRingImpl ZixRing;
 
ZixRing*
zix_ring_new(uint32_t size);
 
void
zix_ring_free(ZixRing* ring);
 
void
zix_ring_mlock(ZixRing* ring);
 
void
zix_ring_reset(ZixRing* ring);
 
uint32_t
zix_ring_read_space(const ZixRing* ring);
 
uint32_t
zix_ring_write_space(const ZixRing* ring);
 
uint32_t
zix_ring_capacity(const ZixRing* ring);
 
uint32_t
zix_ring_peek(ZixRing* ring, void* dst, uint32_t size);
 
uint32_t
zix_ring_read(ZixRing* ring, void* dst, uint32_t size);
 
uint32_t
zix_ring_skip(ZixRing* ring, uint32_t size);
 
uint32_t
zix_ring_write(ZixRing* ring, const void* src, uint32_t size);
 
#ifdef __cplusplus
}  /* extern "C" */
#endif
 
#endif  /* ZIX_RING_H */