timers.h

00001 /*
00002  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
00003  * All rights reserved. 
00004  * 
00005  * Redistribution and use in source and binary forms, with or without modification, 
00006  * are permitted provided that the following conditions are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright notice,
00009  *    this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright notice,
00011  *    this list of conditions and the following disclaimer in the documentation
00012  *    and/or other materials provided with the distribution.
00013  * 3. The name of the author may not be used to endorse or promote products
00014  *    derived from this software without specific prior written permission. 
00015  *
00016  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 
00017  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
00018  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
00019  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
00020  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
00021  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
00022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
00023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
00024  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
00025  * OF SUCH DAMAGE.
00026  *
00027  * This file is part of the lwIP TCP/IP stack.
00028  * 
00029  * Author: Adam Dunkels <adam@sics.se>
00030  *         Simon Goldschmidt
00031  *
00032  */
00033 #ifndef __LWIP_TIMERS_H__
00034 #define __LWIP_TIMERS_H__
00035 
00036 #include "lwip/opt.h"
00037 
00038 /* Timers are not supported when NO_SYS==1 and NO_SYS_NO_TIMERS==1 */
00039 #define LWIP_TIMERS (!NO_SYS || (NO_SYS && !NO_SYS_NO_TIMERS))
00040 
00041 #if LWIP_TIMERS
00042 
00043 #include "lwip/err.h"
00044 #if !NO_SYS
00045 #include "lwip/sys.h"
00046 #endif
00047 
00048 #ifdef __cplusplus
00049 extern "C" {
00050 #endif
00051 
00052 #ifndef LWIP_DEBUG_TIMERNAMES
00053 #ifdef LWIP_DEBUG
00054 #define LWIP_DEBUG_TIMERNAMES SYS_DEBUG
00055 #else /* LWIP_DEBUG */
00056 #define LWIP_DEBUG_TIMERNAMES 0
00057 #endif /* LWIP_DEBUG*/
00058 #endif
00059 
00060 /** Function prototype for a timeout callback function. Register such a function
00061  * using sys_timeout().
00062  *
00063  * @param arg Additional argument to pass to the function - set up by sys_timeout()
00064  */
00065 typedef void (* sys_timeout_handler)(void *arg);
00066 
00067 struct sys_timeo {
00068   struct sys_timeo *next;
00069   u32_t time;
00070   sys_timeout_handler h;
00071   void *arg;
00072 #if LWIP_DEBUG_TIMERNAMES
00073   const char* handler_name;
00074 #endif /* LWIP_DEBUG_TIMERNAMES */
00075 };
00076 
00077 void sys_timeouts_init(void);
00078 
00079 #if LWIP_DEBUG_TIMERNAMES
00080 void sys_timeout_debug(u32_t msecs, sys_timeout_handler handler, void *arg, const char* handler_name);
00081 #define sys_timeout(msecs, handler, arg) sys_timeout_debug(msecs, handler, arg, #handler)
00082 #else /* LWIP_DEBUG_TIMERNAMES */
00083 void sys_timeout(u32_t msecs, sys_timeout_handler handler, void *arg);
00084 #endif /* LWIP_DEBUG_TIMERNAMES */
00085 
00086 void sys_untimeout(sys_timeout_handler handler, void *arg);
00087 #if NO_SYS
00088 void sys_check_timeouts(void);
00089 void sys_restart_timeouts(void);
00090 #else /* NO_SYS */
00091 void sys_timeouts_mbox_fetch(sys_mbox_t *mbox, void **msg);
00092 #endif /* NO_SYS */
00093 
00094 
00095 #ifdef __cplusplus
00096 }
00097 #endif
00098 
00099 #endif /* LWIP_TIMERS */
00100 #endif /* __LWIP_TIMERS_H__ */