3 * $Id: selbuf.h,v 1.2 1999/12/10 23:42:04 mdw Exp $
5 * Line-buffering select handler
7 * (c) 1999 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of the mLib utilities library.
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.
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.
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,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.2 1999/12/10 23:42:04 mdw
34 * Change header file guard names.
36 * Revision 1.1 1999/05/14 21:01:15 mdw
37 * Integrated `select' handling bits from the background resolver project.
48 /*----- Header files ------------------------------------------------------*/
58 /*----- Data structures ---------------------------------------------------*/
60 typedef struct selbuf {
61 sel_file reader; /* File selection object */
62 lbuf b; /* Line buffering object */
65 /*----- Functions provided ------------------------------------------------*/
67 /* --- @selbuf_enable@ --- *
69 * Arguments: @selbuf *b@ = pointer to buffer block
73 * Use: Enables a buffer for reading, and emits any queued lines
74 * to the buffer's owner.
77 extern void selbuf_enable(selbuf */*b*/);
79 /* --- @selbuf_disable@ --- *
81 * Arguments: @selbuf *b@ = pointer to a buffer block
85 * Use: Disables a buffer. It won't be read from until it's
89 extern void selbuf_disable(selbuf */*b*/);
91 /* --- @selbuf_init@ --- *
93 * Arguments: @selbuf *b@ = pointer to buffer block
94 * @sel_state *s@ = pointer to select state to attach to
95 * @int fd@ = file descriptor to listen to
96 * @void (*func)(char *s, void *p)@ = function to call
97 * @void *p@ = argument for function
101 * Use: Initializes a buffer block.
104 extern void selbuf_init(selbuf */*b*/,
107 void (*/*func*/)(char */*s*/, void */*p*/),
110 /*----- That's all, folks -------------------------------------------------*/