| 1 | /* -*-c-*- |
| 2 | * |
| 3 | * $Id: selbuf.h,v 1.5 2004/04/08 01:36:13 mdw Exp $ |
| 4 | * |
| 5 | * Line-buffering select handler |
| 6 | * |
| 7 | * (c) 1999 Straylight/Edgeware |
| 8 | */ |
| 9 | |
| 10 | /*----- Licensing notice --------------------------------------------------* |
| 11 | * |
| 12 | * This file is part of the mLib utilities library. |
| 13 | * |
| 14 | * mLib is free software; you can redistribute it and/or modify |
| 15 | * it under the terms of the GNU Library General Public License as |
| 16 | * published by the Free Software Foundation; either version 2 of the |
| 17 | * License, or (at your option) any later version. |
| 18 | * |
| 19 | * mLib is distributed in the hope that it will be useful, |
| 20 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 21 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 22 | * GNU Library General Public License for more details. |
| 23 | * |
| 24 | * You should have received a copy of the GNU Library General Public |
| 25 | * License along with mLib; if not, write to the Free |
| 26 | * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, |
| 27 | * MA 02111-1307, USA. |
| 28 | */ |
| 29 | |
| 30 | #ifndef MLIB_SELBUF_H |
| 31 | #define MLIB_SELBUF_H |
| 32 | |
| 33 | #ifdef __cplusplus |
| 34 | extern "C" { |
| 35 | #endif |
| 36 | |
| 37 | /*----- Header files ------------------------------------------------------*/ |
| 38 | |
| 39 | #ifndef MLIB_LBUF_H |
| 40 | # include "lbuf.h" |
| 41 | #endif |
| 42 | |
| 43 | #ifndef MLIB_SEL_H |
| 44 | # include "sel.h" |
| 45 | #endif |
| 46 | |
| 47 | /*----- Data structures ---------------------------------------------------*/ |
| 48 | |
| 49 | typedef struct selbuf { |
| 50 | sel_file reader; /* File selection object */ |
| 51 | lbuf b; /* Line buffering object */ |
| 52 | } selbuf; |
| 53 | |
| 54 | /*----- Functions provided ------------------------------------------------*/ |
| 55 | |
| 56 | /* --- @selbuf_enable@ --- * |
| 57 | * |
| 58 | * Arguments: @selbuf *b@ = pointer to buffer block |
| 59 | * |
| 60 | * Returns: --- |
| 61 | * |
| 62 | * Use: Enables a buffer for reading, and emits any queued lines |
| 63 | * to the buffer's owner. |
| 64 | */ |
| 65 | |
| 66 | extern void selbuf_enable(selbuf */*b*/); |
| 67 | |
| 68 | /* --- @selbuf_disable@ --- * |
| 69 | * |
| 70 | * Arguments: @selbuf *b@ = pointer to a buffer block |
| 71 | * |
| 72 | * Returns: --- |
| 73 | * |
| 74 | * Use: Disables a buffer. It won't be read from until it's |
| 75 | * enabled again. |
| 76 | */ |
| 77 | |
| 78 | extern void selbuf_disable(selbuf */*b*/); |
| 79 | |
| 80 | /* --- @selbuf_setsize@ --- * |
| 81 | * |
| 82 | * Arguments: @selbuf *b@ = pointer to buffer block |
| 83 | * @size_t sz@ = size of buffer |
| 84 | * |
| 85 | * Returns: --- |
| 86 | * |
| 87 | * Use: Sets the size of the buffer used for reading lines. |
| 88 | */ |
| 89 | |
| 90 | extern void selbuf_setsize(selbuf */*b*/, size_t /*sz*/); |
| 91 | |
| 92 | /* --- @selbuf_init@ --- * |
| 93 | * |
| 94 | * Arguments: @selbuf *b@ = pointer to buffer block |
| 95 | * @sel_state *s@ = pointer to select state to attach to |
| 96 | * @int fd@ = file descriptor to listen to |
| 97 | * @lbuf_func *func@ = function to call |
| 98 | * @void *p@ = argument for function |
| 99 | * |
| 100 | * Returns: --- |
| 101 | * |
| 102 | * Use: Initializes a buffer block. |
| 103 | */ |
| 104 | |
| 105 | extern void selbuf_init(selbuf */*b*/, sel_state */*s*/, int /*fd*/, |
| 106 | lbuf_func */*func*/, void */*p*/); |
| 107 | |
| 108 | /* --- @selbuf_destroy@ --- * |
| 109 | * |
| 110 | * Arguments: @selbuf *b@ = pointer to buffer block |
| 111 | * |
| 112 | * Returns: --- |
| 113 | * |
| 114 | * Use: Deallocates a line buffer and frees any resources it owned. |
| 115 | */ |
| 116 | |
| 117 | extern void selbuf_destroy(selbuf */*b*/); |
| 118 | |
| 119 | /*----- That's all, folks -------------------------------------------------*/ |
| 120 | |
| 121 | #ifdef __cplusplus |
| 122 | } |
| 123 | #endif |
| 124 | |
| 125 | #endif |