xref: /freebsd/usr.sbin/ppp/timer.h (revision 266b0663c598b7e50c2998974c16f89b7ac23e3a)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 1996 - 2001 Brian Somers <brian@Awfulhak.org>
5  *          based on work by Toshiharu OHNO <tony-o@iij.ad.jp>
6  *                           Internet Initiative Japan, Inc (IIJ)
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * $FreeBSD$
31  */
32 
33 #define	TICKUNIT	100000			/* usec's per Unit */
34 #define	SECTICKS	(1000000/TICKUNIT)	/* Units per second */
35 
36 struct pppTimer {
37   int state;
38   const char *name;
39   u_long rest;			/* Ticks to expire */
40   u_long load;			/* Initial load value */
41   void (*func)(void *);		/* Function called when timer is expired */
42   void *arg;			/* Argument passed to timeout function */
43   struct pppTimer *next;	/* Link to next timer */
44   struct pppTimer *enext;	/* Link to next expired timer */
45 };
46 
47 #define	TIMER_STOPPED	0
48 #define	TIMER_RUNNING	1
49 #define	TIMER_EXPIRED	2
50 
51 struct prompt;
52 
53 extern void timer_Start(struct pppTimer *);
54 extern void timer_Stop(struct pppTimer *);
55 extern void timer_InitService(int);
56 extern void timer_TermService(void);
57 extern void timer_Show(int LogLevel, struct prompt *);
58