3 * $Id: selbuf.h,v 1.4 2002/01/13 13:33:15 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.4 2002/01/13 13:33:15 mdw
34 * Track interface change for @lbuf@.
36 * Revision 1.3 2000/06/17 10:38:14 mdw
37 * Add support for variable buffer sizes.
39 * Revision 1.2 1999/12/10 23:42:04 mdw
40 * Change header file guard names.
42 * Revision 1.1 1999/05/14 21:01:15 mdw
43 * Integrated `select' handling bits from the background resolver project.
54 /*----- Header files ------------------------------------------------------*/
64 /*----- Data structures ---------------------------------------------------*/
66 typedef struct selbuf {
67 sel_file reader; /* File selection object */
68 lbuf b; /* Line buffering object */
71 /*----- Functions provided ------------------------------------------------*/
73 /* --- @selbuf_enable@ --- *
75 * Arguments: @selbuf *b@ = pointer to buffer block
79 * Use: Enables a buffer for reading, and emits any queued lines
80 * to the buffer's owner.
83 extern void selbuf_enable(selbuf */*b*/);
85 /* --- @selbuf_disable@ --- *
87 * Arguments: @selbuf *b@ = pointer to a buffer block
91 * Use: Disables a buffer. It won't be read from until it's
95 extern void selbuf_disable(selbuf */*b*/);
97 /* --- @selbuf_setsize@ --- *
99 * Arguments: @selbuf *b@ = pointer to buffer block
100 * @size_t sz@ = size of buffer
104 * Use: Sets the size of the buffer used for reading lines.
107 extern void selbuf_setsize(selbuf */*b*/, size_t /*sz*/);
109 /* --- @selbuf_init@ --- *
111 * Arguments: @selbuf *b@ = pointer to buffer block
112 * @sel_state *s@ = pointer to select state to attach to
113 * @int fd@ = file descriptor to listen to
114 * @lbuf_func *func@ = function to call
115 * @void *p@ = argument for function
119 * Use: Initializes a buffer block.
122 extern void selbuf_init(selbuf */*b*/, sel_state */*s*/, int /*fd*/,
123 lbuf_func */*func*/, void */*p*/);
125 /* --- @selbuf_destroy@ --- *
127 * Arguments: @selbuf *b@ = pointer to buffer block
131 * Use: Deallocates a line buffer and frees any resources it owned.
134 extern void selbuf_destroy(selbuf */*b*/);
136 /*----- That's all, folks -------------------------------------------------*/