1 /* 2 * Copyright (c) 2001-2004 Swedish Institute of Computer Science. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without modification, 6 * are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, 9 * this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright notice, 11 * this list of conditions and the following disclaimer in the documentation 12 * and/or other materials provided with the distribution. 13 * 3. The name of the author may not be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 19 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 21 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 24 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 25 * OF SUCH DAMAGE. 26 * 27 * This file is part of the lwIP TCP/IP stack. 28 * 29 * Author: Adam Dunkels <adam (at) sics.se> 30 * Simon Goldschmidt 31 * 32 */ 33 #ifndef __LWIP_TIMERS_H__ 34 #define __LWIP_TIMERS_H__ 35 36 #include "lwip/opt.h" 37 38 /* Timers are not supported when NO_SYS==1 and NO_SYS_NO_TIMERS==1 */ 39 #define LWIP_TIMERS (!NO_SYS || (NO_SYS && !NO_SYS_NO_TIMERS)) 40 41 #if LWIP_TIMERS 42 43 #include "lwip/err.h" 44 #include "lwip/sys.h" 45 46 #ifdef __cplusplus 47 extern "C" { 48 #endif 49 50 #ifndef LWIP_DEBUG_TIMERNAMES 51 #ifdef LWIP_DEBUG 52 #define LWIP_DEBUG_TIMERNAMES SYS_DEBUG 53 #else /* LWIP_DEBUG */ 54 #define LWIP_DEBUG_TIMERNAMES 0 55 #endif /* LWIP_DEBUG*/ 56 #endif 57 58 /** Function prototype for a timeout callback function. Register such a function 59 * using sys_timeout(). 60 * 61 * @param arg Additional argument to pass to the function - set up by sys_timeout() 62 */ 63 typedef void (* sys_timeout_handler)(void *arg); 64 65 struct sys_timeo { 66 struct sys_timeo *next; 67 u32_t time; 68 sys_timeout_handler h; 69 void *arg; 70 #if LWIP_DEBUG_TIMERNAMES 71 const char* handler_name; 72 #endif /* LWIP_DEBUG_TIMERNAMES */ 73 }; 74 75 void sys_timeouts_init(void); 76 77 #if LWIP_DEBUG_TIMERNAMES 78 void sys_timeout_debug(u32_t msecs, sys_timeout_handler handler, void *arg, const char* handler_name); 79 #define sys_timeout(msecs, handler, arg) sys_timeout_debug(msecs, handler, arg, #handler) 80 #else /* LWIP_DEBUG_TIMERNAMES */ 81 void sys_timeout(u32_t msecs, sys_timeout_handler handler, void *arg); 82 #endif /* LWIP_DEBUG_TIMERNAMES */ 83 84 void sys_untimeout(sys_timeout_handler handler, void *arg); 85 #if NO_SYS 86 void sys_check_timeouts(void); 87 void sys_restart_timeouts(void); 88 #else /* NO_SYS */ 89 void sys_timeouts_mbox_fetch(sys_mbox_t *mbox, void **msg); 90 #endif /* NO_SYS */ 91 92 93 #ifdef __cplusplus 94 } 95 #endif 96 97 #endif /* LWIP_TIMERS */ 98 #endif /* __LWIP_TIMERS_H__ */ 99
