---

shbuf.h

Go to the documentation of this file.

#ifndef fooshbufhfoo
#define fooshbufhfoo

/* $Id: shbuf.h,v 1.6 2003/09/09 22:14:58 poettering Exp $
 *
 * This file is part of libshbuf. 
 *
 * libshbuf is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * libshbuf is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with libshbuf; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 */

#include <sys/types.h>

struct _shbuf;

typedef struct _shbuf shbuf;

typedef struct {
    unsigned long read_idx;      
    unsigned long length;        
    unsigned long backlog;       
    unsigned long backlog_target; 
    unsigned long write_count;   
    unsigned long read_count;    
    int ignore_read_inc;         
    int ignore_write_inc;        
} shbuf_status;

shbuf* shbuf_create(key_t key, unsigned long size);

shbuf* shbuf_open(key_t key);

void shbuf_free(shbuf* sb);

int shbuf_access(shbuf* sb, int mode);

key_t shbuf_get_key(shbuf* sb);

unsigned long shbuf_get_size(shbuf* sb);

unsigned char* shbuf_get_pointer(shbuf* sb);

shbuf_status* shbuf_get_status(shbuf* sb);

int shbuf_notify_enable(shbuf* sb, int b);

int shbuf_notify(shbuf* sb);

int shbuf_wait(shbuf* sb);

int shbuf_get_select_fd(shbuf* sb);

int shbuf_post_select(shbuf *sb);

int shbuf_status_lock(shbuf* sb);

int shbuf_status_unlock(shbuf* sb);

int shbuf_reset(shbuf* sb);

int shbuf_zero(shbuf* sb);

int shbuf_set_backlog_target(shbuf *sb, unsigned long bl);

unsigned long shbuf_get_backlog_target(shbuf *sb);

const unsigned char* shbuf_get_read_pointer(shbuf *sb, unsigned long *l);

int shbuf_inc_read_pointer(shbuf *sb, unsigned long r);

unsigned char* shbuf_get_write_pointer(shbuf *sb, unsigned long *l);

int shbuf_inc_write_pointer(shbuf *sb, unsigned long r);

int shbuf_connected(shbuf *sb);

int shbuf_is_full(shbuf *sb);

int shbuf_is_empty(shbuf *sb);

unsigned long shbuf_rewind(shbuf *sb, unsigned long v);

signed long shbuf_read(shbuf *sb, unsigned char*c, signed long l);

signed long shbuf_write(shbuf *sb, const unsigned char*c, signed long l);

#endif

---