Return to ring.h CVS log

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

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

1.5     ! millert     1: /*     $OpenBSD: ring.h,v 1.4 1998/05/15 03:16:42 art 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.
                     16:  * 3. All advertising materials mentioning features or use of this software
                     17:  *    must display the following acknowledgement:
                     18:  *     This product includes software developed by the University of
                     19:  *     California, Berkeley and its contributors.
                     20:  * 4. Neither the name of the University nor the names of its contributors
                     21:  *    may be used to endorse or promote products derived from this software
                     22:  *    without specific prior written permission.
                     23:  *
                     24:  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     25:  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     26:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     27:  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     28:  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     29:  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     30:  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     31:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     32:  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     33:  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     34:  * SUCH DAMAGE.
                     35:  *
                     36:  *     from: @(#)ring.h        8.1 (Berkeley) 6/6/93
                     37:  */
                     38:
                     39: /*
                     40:  * This defines a structure for a ring buffer.
                     41:  *
                     42:  * The circular buffer has two parts:
                     43:  *(((
                     44:  *     full:   [consume, supply)
                     45:  *     empty:  [supply, consume)
                     46:  *]]]
                     47:  *
                     48:  */
                     49: typedef struct {
                     50:     unsigned char      *consume,       /* where data comes out of */
                     51:                        *supply,        /* where data comes in to */
                     52:                        *bottom,        /* lowest address in buffer */
                     53:                        *top,           /* highest address+1 in buffer */
                     54:                        *mark;          /* marker (user defined) */
1.3       art        55: #if    defined(ENCRYPTION)
                     56:     unsigned char      *clearto;       /* Data to this point is clear text */
                     57:     unsigned char      *encryyptedto;  /* Data is encrypted to here */
                     58: #endif
1.1       deraadt    59:     int                size;           /* size in bytes of buffer */
                     60:     u_long     consumetime,    /* help us keep straight full, empty, etc. */
                     61:                supplytime;
                     62: } Ring;
                     63:
                     64: /* Here are some functions and macros to deal with the ring buffer */
                     65:
                     66: /* Initialization routine */
                     67: extern int
1.5     ! millert    68:        ring_init(Ring *ring, unsigned char *buffer, int count);
1.1       deraadt    69:
                     70: /* Data movement routines */
                     71: extern void
1.5     ! millert    72:        ring_supply_data(Ring *ring, unsigned char *buffer, int count);
1.1       deraadt    73: #ifdef notdef
                     74: extern void
1.5     ! millert    75:        ring_consume_data(Ring *ring, unsigned char *buffer, int count);
1.1       deraadt    76: #endif
                     77:
                     78: /* Buffer state transition routines */
                     79: extern void
1.5     ! millert    80:        ring_supplied(Ring *ring, int count),
        !            81:        ring_consumed(Ring *ring, int count);
1.1       deraadt    82:
                     83: /* Buffer state query routines */
                     84: extern int
1.5     ! millert    85:        ring_empty_count(Ring *ring),
        !            86:        ring_empty_consecutive(Ring *ring),
        !            87:        ring_full_count(Ring *ring),
        !            88:        ring_full_consecutive(Ring *ring);
1.1       deraadt    89:
1.3       art        90: #if    defined(ENCRYPTION)
                     91: extern void
                     92:        ring_encrypt (Ring *ring, void (*func)()),
                     93:        ring_clearto (Ring *ring);
                     94: #endif
                     95:
1.1       deraadt    96:
                     97: extern void
1.5     ! millert    98:     ring_clear_mark(Ring *),
        !            99:     ring_mark(Ring *);
1.4       art       100:
                    101:
                    102: extern int
1.5     ! millert   103:     ring_at_mark(Ring *);