Keil Studio Cloud
Mistake on this page?
Report an issue in GitHub or email us
timeouts.h
Go to the documentation of this file.
1 /**
2  * @file
3  * Timer implementations
4  */
5 
6 /*
7  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without modification,
11  * are permitted provided that the following conditions are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright notice,
14  * this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  * 3. The name of the author may not be used to endorse or promote products
19  * derived from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
22  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
24  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
29  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
30  * OF SUCH DAMAGE.
31  *
32  * This file is part of the lwIP TCP/IP stack.
33  *
34  * Author: Adam Dunkels <adam@sics.se>
35  * Simon Goldschmidt
36  *
37  */
38 #ifndef LWIP_HDR_TIMEOUTS_H
39 #define LWIP_HDR_TIMEOUTS_H
40 
41 #include "lwip/opt.h"
42 #include "lwip/err.h"
43 #if !NO_SYS
44 #include "lwip/sys.h"
45 #endif
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 #ifndef LWIP_DEBUG_TIMERNAMES
52 #ifdef LWIP_DEBUG
53 #define LWIP_DEBUG_TIMERNAMES SYS_DEBUG
54 #else /* LWIP_DEBUG */
55 #define LWIP_DEBUG_TIMERNAMES 0
56 #endif /* LWIP_DEBUG*/
57 #endif
58 
59 /** Returned by sys_timeouts_sleeptime() to indicate there is no timer, so we
60  * can sleep forever.
61  */
62 #define SYS_TIMEOUTS_SLEEPTIME_INFINITE 0xFFFFFFFF
63 
64 /** Function prototype for a stack-internal timer function that has to be
65  * called at a defined interval */
66 typedef void (* lwip_cyclic_timer_handler)(void);
67 
68 /** This struct contains information about a stack-internal timer function
69  that has to be called at a defined interval */
70 struct lwip_cyclic_timer {
71  u32_t interval_ms;
72  lwip_cyclic_timer_handler handler;
73 #if LWIP_DEBUG_TIMERNAMES
74  const char* handler_name;
75 #endif /* LWIP_DEBUG_TIMERNAMES */
76 };
77 
78 /** This array contains all stack-internal cyclic timers. To get the number of
79  * timers, use lwip_num_cyclic_timers */
80 extern const struct lwip_cyclic_timer lwip_cyclic_timers[];
81 /** Array size of lwip_cyclic_timers[] */
82 extern const int lwip_num_cyclic_timers;
83 
84 #if LWIP_TIMERS
85 
86 /** Function prototype for a timeout callback function. Register such a function
87  * using sys_timeout().
88  *
89  * @param arg Additional argument to pass to the function - set up by sys_timeout()
90  */
91 typedef void (* sys_timeout_handler)(void *arg);
92 
93 struct sys_timeo {
94  struct sys_timeo *next;
95  u32_t time;
96  sys_timeout_handler h;
97  void *arg;
98 #if LWIP_DEBUG_TIMERNAMES
99  const char* handler_name;
100 #endif /* LWIP_DEBUG_TIMERNAMES */
101 };
102 
103 void sys_timeouts_init(void);
104 
105 #if LWIP_DEBUG_TIMERNAMES
106 void sys_timeout_debug(u32_t msecs, sys_timeout_handler handler, void *arg, const char* handler_name);
107 #define sys_timeout(msecs, handler, arg) sys_timeout_debug(msecs, handler, arg, #handler)
108 #else /* LWIP_DEBUG_TIMERNAMES */
109 void sys_timeout(u32_t msecs, sys_timeout_handler handler, void *arg);
110 #endif /* LWIP_DEBUG_TIMERNAMES */
111 
112 void sys_untimeout(sys_timeout_handler handler, void *arg);
113 void sys_restart_timeouts(void);
114 void sys_check_timeouts(void);
115 u32_t sys_timeouts_sleeptime(void);
116 
117 #if LWIP_TESTMODE
118 struct sys_timeo** sys_timeouts_get_next_timeout(void);
119 void lwip_cyclic_timer(void *arg);
120 #endif
121 
122 #endif /* LWIP_TIMERS */
123 
124 #ifdef __cplusplus
125 }
126 #endif
127 
128 #endif /* LWIP_HDR_TIMEOUTS_H */
lwip_num_cyclic_timers
const int lwip_num_cyclic_timers
Array size of lwip_cyclic_timers[].
sys.h
OS abstraction layer.
opt.h
lwIP Options Configuration
err.h
lwIP Error codes
lwip_cyclic_timer_handler
void(* lwip_cyclic_timer_handler)(void)
Function prototype for a stack-internal timer function that has to be called at a defined interval...
Definition: timeouts.h:66
lwip_cyclic_timer
This struct contains information about a stack-internal timer function that has to be called at a def...
Definition: timeouts.h:70
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.