racoon.tproj/schedule.h

   1 /*      $KAME: schedule.h,v 1.12 2001/03/06 20:41:02 thorpej Exp $      */
   2
   3 /*
   4  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the project nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  */
  31
  32 #ifndef __SCHEDULE_H__
  33 #define __SCHEDULE_H__
  34
  35 #include <sys/queue.h>
  36
  37 /* scheduling table */
  38 /* the head is the nearest event. */
  39 struct sched {
  40         time_t xtime;           /* event time which is as time(3). */
  41                                 /*
  42                                  * if defined FIXY2038PROBLEM, this time
  43                                  * is from the time when called sched_init().
  44                                  */
  45         void (*func) __P((void *)); /* call this function when timeout. */
  46         void *param;            /* pointer to parameter */
  47
  48         int dead;               /* dead or alive */
  49         long id;                /* for debug */
  50         time_t created;         /* for debug */
  51         time_t tick;            /* for debug */
  52
  53         TAILQ_ENTRY(sched) chain;
  54 };
  55
  56 /* cancel schedule */
  57 #define SCHED_KILL(s)                                                          \
  58 do {                                                                           \
  59         sched_kill(s);                                                         \
  60         s = NULL;                                                              \
  61 } while(0)
  62
  63 /* must be called after it's called from scheduler. */
  64 #define SCHED_INIT(s)   (s) = NULL
  65
  66 struct scheddump {
  67         time_t xtime;
  68         long id;
  69         time_t created;
  70         time_t tick;
  71 };
  72
  73 struct timeval *schedular __P((void));
  74 struct sched *sched_new __P((time_t, void (*func) __P((void *)), void *));
  75 void sched_kill __P((struct sched *));
  76 int sched_dump __P((caddr_t *, int *));
  77 void sched_init __P((void));
  78 void sched_scrub_param __P((void *));
  79
  80 #endif /* __SCHEDULE_H__ */
  81