Return to ring.h CVS log

Up to [local] / src / usr.bin / telnet

Annotation of src/usr.bin/telnet/ring.h, Revision 1.7

1.7     ! guenther    1: /*     $OpenBSD: ring.h,v 1.6 2003/06/03 02:56:18 millert Exp $        */
1.2       niklas      2: /*     $NetBSD: ring.h,v 1.5 1996/02/28 21:04:09 thorpej Exp $ */
                      3:
1.1       deraadt     4: /*
                      5:  * Copyright (c) 1988, 1993
                      6:  *     The Regents of the University of California.  All rights reserved.
                      7:  *
                      8:  * Redistribution and use in source and binary forms, with or without
                      9:  * modification, are permitted provided that the following conditions
                     10:  * are met:
                     11:  * 1. Redistributions of source code must retain the above copyright
                     12:  *    notice, this list of conditions and the following disclaimer.
                     13:  * 2. Redistributions in binary form must reproduce the above copyright
                     14:  *    notice, this list of conditions and the following disclaimer in the
                     15:  *    documentation and/or other materials provided with the distribution.
1.6       millert    16:  * 3. Neither the name of the University nor the names of its contributors
1.1       deraadt    17:  *    may be used to endorse or promote products derived from this software
                     18:  *    without specific prior written permission.
                     19:  *
                     20:  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     21:  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     22:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     23:  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     24:  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     25:  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     26:  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     27:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     28:  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     29:  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     30:  * SUCH DAMAGE.
                     31:  *
                     32:  *     from: @(#)ring.h        8.1 (Berkeley) 6/6/93
                     33:  */
                     34:
                     35: /*
                     36:  * This defines a structure for a ring buffer.
                     37:  *
                     38:  * The circular buffer has two parts:
                     39:  *(((
                     40:  *     full:   [consume, supply)
                     41:  *     empty:  [supply, consume)
                     42:  *]]]
                     43:  *
                     44:  */
                     45: typedef struct {
                     46:     unsigned char      *consume,       /* where data comes out of */
                     47:                        *supply,        /* where data comes in to */
                     48:                        *bottom,        /* lowest address in buffer */
                     49:                        *top,           /* highest address+1 in buffer */
                     50:                        *mark;          /* marker (user defined) */
                     51:     int                size;           /* size in bytes of buffer */
                     52:     u_long     consumetime,    /* help us keep straight full, empty, etc. */
                     53:                supplytime;
                     54: } Ring;
                     55:
                     56: /* Here are some functions and macros to deal with the ring buffer */
                     57:
                     58: /* Initialization routine */
                     59: extern int
1.5       millert    60:        ring_init(Ring *ring, unsigned char *buffer, int count);
1.1       deraadt    61:
                     62: /* Data movement routines */
                     63: extern void
1.5       millert    64:        ring_supply_data(Ring *ring, unsigned char *buffer, int count);
1.1       deraadt    65:
                     66: /* Buffer state transition routines */
                     67: extern void
1.5       millert    68:        ring_supplied(Ring *ring, int count),
                     69:        ring_consumed(Ring *ring, int count);
1.1       deraadt    70:
                     71: /* Buffer state query routines */
                     72: extern int
1.5       millert    73:        ring_empty_count(Ring *ring),
                     74:        ring_empty_consecutive(Ring *ring),
                     75:        ring_full_count(Ring *ring),
                     76:        ring_full_consecutive(Ring *ring);
1.1       deraadt    77:
                     78: extern void
1.5       millert    79:     ring_clear_mark(Ring *),
                     80:     ring_mark(Ring *);
1.4       art        81:
                     82:
                     83: extern int
1.5       millert    84:     ring_at_mark(Ring *);