usr.sbin/ppp/timer.h

   1 /*-
   2  * Copyright (c) 1996 - 2001 Brian Somers <brian@Awfulhak.org>
   3  *          based on work by Toshiharu OHNO <tony-o@iij.ad.jp>
   4  *                           Internet Initiative Japan, Inc (IIJ)
   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  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD: src/usr.sbin/ppp/timer.h,v 1.9.2.1 2001/06/13 21:56:36 brian Exp $
  29  * $DragonFly: src/usr.sbin/ppp/timer.h,v 1.2 2003/06/17 04:30:01 dillon Exp $
  30  */
  31
  32 #define TICKUNIT        100000                  /* usec's per Unit */
  33 #define SECTICKS        (1000000/TICKUNIT)      /* Units per second */
  34
  35 struct pppTimer {
  36   int state;
  37   const char *name;
  38   u_long rest;                  /* Ticks to expire */
  39   u_long load;                  /* Initial load value */
  40   void (*func)(void *);         /* Function called when timer is expired */
  41   void *arg;                    /* Argument passed to timeout function */
  42   struct pppTimer *next;        /* Link to next timer */
  43   struct pppTimer *enext;       /* Link to next expired timer */
  44 };
  45
  46 #define TIMER_STOPPED   0
  47 #define TIMER_RUNNING   1
  48 #define TIMER_EXPIRED   2
  49
  50 struct prompt;
  51
  52 extern void timer_Start(struct pppTimer *);
  53 extern void timer_Stop(struct pppTimer *);
  54 extern void timer_InitService(int);
  55 extern void timer_TermService(void);
  56 extern void timer_Show(int LogLevel, struct prompt *);