src/eventl.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2008 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /**
  29  * \file eventl.h
  30  * \brief Definitions for event loop handling for GFS.
  31  *
  32  * This "private" header defines various functions for the
  33  * main event loop in GFS.
  34  */
  35
  36 #ifndef EVENTL_H
  37 #define EVENTL_H
  38
  39 #include <time.h>
  40
  41 struct iochan;
  42
  43 typedef void (*IOC_CALLBACK)(struct iochan *i, int event);
  44
  45 typedef struct iochan
  46 {
  47     int fd;
  48     int flags;
  49 #define EVENT_INPUT     0x01
  50 #define EVENT_OUTPUT    0x02
  51 #define EVENT_EXCEPT    0x04
  52 #define EVENT_TIMEOUT   0x08
  53 int force_event;
  54     IOC_CALLBACK fun;
  55     void *data;
  56     int destroyed;
  57     time_t last_event;
  58     time_t max_idle;
  59
  60     struct iochan *next;
  61     int chan_id; /* listening port (0 if none ) */
  62 } *IOCHAN;
  63
  64 #define iochan_destroy(i) (void)((i)->destroyed = 1)
  65 #define iochan_getfd(i) ((i)->fd)
  66 #define iochan_setfd(i, f) ((i)->fd = (f))
  67 #define iochan_getdata(i) ((i)->data)
  68 #define iochan_setdata(i, d) ((i)->data = d)
  69 #define iochan_getflags(i) ((i)->flags)
  70 #define iochan_setflags(i, d) ((i)->flags = d)
  71 #define iochan_setflag(i, d) ((i)->flags |= d)
  72 #define iochan_clearflag(i, d) ((i)->flags &= ~(d))
  73 #define iochan_getflag(i, d) ((i)->flags & d ? 1 : 0)
  74 #define iochan_getfun(i) ((i)->fun)
  75 #define iochan_setfun(i, d) ((i)->fun = d)
  76 #define iochan_setevent(i, e) ((i)->force_event = (e))
  77 #define iochan_getnext(i) ((i)->next)
  78 #define iochan_settimeout(i, t) ((i)->max_idle = (t), (i)->last_event = time(0))
  79
  80 IOCHAN iochan_create(int fd, IOC_CALLBACK cb, int flags, int port);
  81 int iochan_is_alive(IOCHAN chan);
  82 int iochan_event_loop(IOCHAN *iochans);
  83 void statserv_remove (IOCHAN pIOChannel);
  84 #endif
  85 /*
  86  * Local variables:
  87  * c-basic-offset: 4
  88  * indent-tabs-mode: nil
  89  * End:
  90  * vim: shiftwidth=4 tabstop=8 expandtab
  91  */
  92