chiark - git - mdw - mLib/blob - selbuf.h

   1 /* -*-c-*-
   2  *
   3  * $Id: selbuf.h,v 1.2 1999/12/10 23:42:04 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 /*----- Revision history --------------------------------------------------*
  31  *
  32  * $Log: selbuf.h,v $
  33  * Revision 1.2  1999/12/10 23:42:04  mdw
  34  * Change header file guard names.
  35  *
  36  * Revision 1.1  1999/05/14 21:01:15  mdw
  37  * Integrated `select' handling bits from the background resolver project.
  38  *
  39  */
  40
  41 #ifndef MLIB_SELBUF_H
  42 #define MLIB_SELBUF_H
  43
  44 #ifdef __cplusplus
  45   extern "C" {
  46 #endif
  47
  48 /*----- Header files ------------------------------------------------------*/
  49
  50 #ifndef MLIB_LBUF_H
  51 #  include "lbuf.h"
  52 #endif
  53
  54 #ifndef MLIB_SEL_H
  55 #  include "sel.h"
  56 #endif
  57
  58 /*----- Data structures ---------------------------------------------------*/
  59
  60 typedef struct selbuf {
  61   sel_file reader;                      /* File selection object */
  62   lbuf b;                               /* Line buffering object */
  63 } selbuf;
  64
  65 /*----- Functions provided ------------------------------------------------*/
  66
  67 /* --- @selbuf_enable@ --- *
  68  *
  69  * Arguments:   @selbuf *b@ = pointer to buffer block
  70  *
  71  * Returns:     ---
  72  *
  73  * Use:         Enables a buffer for reading, and emits any queued lines
  74  *              to the buffer's owner.
  75  */
  76
  77 extern void selbuf_enable(selbuf */*b*/);
  78
  79 /* --- @selbuf_disable@ --- *
  80  *
  81  * Arguments:   @selbuf *b@ = pointer to a buffer block
  82  *
  83  * Returns:     ---
  84  *
  85  * Use:         Disables a buffer.  It won't be read from until it's
  86  *              enabled again.
  87  */
  88
  89 extern void selbuf_disable(selbuf */*b*/);
  90
  91 /* --- @selbuf_init@ --- *
  92  *
  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
  98  *
  99  * Returns:     ---
 100  *
 101  * Use:         Initializes a buffer block.
 102  */
 103
 104 extern void selbuf_init(selbuf */*b*/,
 105                         sel_state */*s*/,
 106                         int /*fd*/,
 107                         void (*/*func*/)(char */*s*/, void */*p*/),
 108                         void */*p*/);
 109
 110 /*----- That's all, folks -------------------------------------------------*/
 111
 112 #ifdef __cplusplus
 113   }
 114 #endif
 115
 116 #endif