Return to aring.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / libelwix / inc / elwix

Annotation of libelwix/inc/elwix/aring.h, revision 1.1.2.1

1.1.2.1 ! misho       1: /*************************************************************************
        !             2: * (C) 2025 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
        !             3: *  by Michael Pounov <misho@elwix.org>
        !             4: *
        !             5: * $Author: misho $
        !             6: * $Id: aarray.h,v 1.13 2025/08/21 15:43:00 misho Exp $
        !             7: *
        !             8: **************************************************************************
        !             9: The ELWIX and AITNET software is distributed under the following
        !            10: terms:
        !            11: 
        !            12: All of the documentation and software included in the ELWIX and AITNET
        !            13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
        !            14: 
        !            15: Copyright 2004 - 2025
        !            16:        by Michael Pounov <misho@elwix.org>.  All rights reserved.
        !            17: 
        !            18: Redistribution and use in source and binary forms, with or without
        !            19: modification, are permitted provided that the following conditions
        !            20: are met:
        !            21: 1. Redistributions of source code must retain the above copyright
        !            22:    notice, this list of conditions and the following disclaimer.
        !            23: 2. Redistributions in binary form must reproduce the above copyright
        !            24:    notice, this list of conditions and the following disclaimer in the
        !            25:    documentation and/or other materials provided with the distribution.
        !            26: 3. All advertising materials mentioning features or use of this software
        !            27:    must display the following acknowledgement:
        !            28: This product includes software developed by Michael Pounov <misho@elwix.org>
        !            29: ELWIX - Embedded LightWeight unIX and its contributors.
        !            30: 4. Neither the name of AITNET nor the names of its contributors
        !            31:    may be used to endorse or promote products derived from this software
        !            32:    without specific prior written permission.
        !            33: 
        !            34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
        !            35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        !            36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
        !            37: ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
        !            38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        !            39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
        !            40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
        !            41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
        !            42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
        !            43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
        !            44: SUCH DAMAGE.
        !            45: */
        !            46: #ifndef __ARING_H
        !            47: #define __ARING_H
        !            48: 
        !            49: 
        !            50: typedef struct {
        !            51:        atomic_int      rb_head;
        !            52:        atomic_int      rb_tail;
        !            53:        int             rb_bufnum;
        !            54:        struct iovec    *rb_buffer;
        !            55: } ringbuf_t;
        !            56: 
        !            57: 
        !            58: /*
        !            59:  * rbuf_init() - Init ring buffer
        !            60:  *
        !            61:  * @rbuf = Ring buffer
        !            62:  * @num = Number of elements in buffer
        !            63:  * return: -1 error or 0 ok
        !            64:  */
        !            65: int rbuf_init(ringbuf_t *rbuf, int num);
        !            66: /*
        !            67:  * rbuf_free() - Free ring buffer
        !            68:  *
        !            69:  * @rbuf = Ring buffer
        !            70:  * return: none
        !            71:  */
        !            72: void rbuf_free(ringbuf_t *rbuf);
        !            73: /*
        !            74:  * rbuf_purge() - Purge all buffer
        !            75:  *
        !            76:  * @rbuf = Ring buffer
        !            77:  * return: none
        !            78:  */
        !            79: void rbuf_purge(ringbuf_t *rbuf);
        !            80: /*
        !            81:  * rbuf_isempty() - Check buffer is empty
        !            82:  *
        !            83:  * @rbuf = Ring buffer
        !            84:  * return: -1 error, 0 it isn't empty
        !            85:  */
        !            86: int rbuf_isempty(ringbuf_t *rbuf);
        !            87: /*
        !            88:  * rbuf_isfull() - Check buffer is full
        !            89:  *
        !            90:  * @rbuf = Ring buffer
        !            91:  * return: -1 error or 0 it isn't full
        !            92:  */
        !            93: int rbuf_isfull(ringbuf_t *rbuf);
        !            94: 
        !            95: /*
        !            96:  * rbuf_enqueue() - Enqueue data to buffer
        !            97:  *
        !            98:  * @rbuf = Ring buffer
        !            99:  * @data = Data
        !           100:  * @len = Length
        !           101:  * return: -1 error, 1 can't add data, buffer is full or 0 ok
        !           102:  */
        !           103: int rbuf_enqueue(ringbuf_t *rbuf, void *data, size_t len);
        !           104: /*
        !           105:  * rbuf_dequeue() - Dequeue data from buffer
        !           106:  *
        !           107:  * @rbuf = Ring buffer
        !           108:  * @out = Data, if =NULL, just dequeue data
        !           109:  * return: -1 error, 1 buffer is empty or 0 ok
        !           110:  */
        !           111: int rbuf_dequeue(ringbuf_t *rbuf, struct iovec *out);
        !           112: 
        !           113: 
        !           114: #endif