l4/pkg/ankh/lib/lwip/contrib/src/include/lwip/timers.h

   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@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 #include "lwip/err.h"
  39 #include "lwip/sys.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 #ifndef LWIP_DEBUG_TIMERNAMES
  46 #ifdef LWIP_DEBUG
  47 #define LWIP_DEBUG_TIMERNAMES SYS_DEBUG
  48 #else /* LWIP_DEBUG */
  49 #define LWIP_DEBUG_TIMERNAMES 0
  50 #endif /* LWIP_DEBUG*/
  51 #endif
  52
  53 /** Function prototype for a timeout callback function. Register such a function
  54  * using sys_timeout().
  55  *
  56  * @param arg Additional argument to pass to the function - set up by sys_timeout()
  57  */
  58 typedef void (* sys_timeout_handler)(void *arg);
  59
  60 struct sys_timeo {
  61   struct sys_timeo *next;
  62   u32_t time;
  63   sys_timeout_handler h;
  64   void *arg;
  65 #if LWIP_DEBUG_TIMERNAMES
  66   const char* handler_name;
  67 #endif /* LWIP_DEBUG_TIMERNAMES */
  68 };
  69
  70 void sys_timeouts_init(void);
  71
  72 #if LWIP_DEBUG_TIMERNAMES
  73 void sys_timeout_debug(u32_t msecs, sys_timeout_handler h, void *arg, const char* handler_name);
  74 #define sys_timeout(msecs, handler, arg) sys_timeout_debug(msecs, handler, arg, #handler)
  75 #else /* LWIP_DEBUG_TIMERNAMES */
  76 void sys_timeout(u32_t msecs, sys_timeout_handler h, void *arg);
  77 #endif /* LWIP_DEBUG_TIMERNAMES */
  78
  79 void sys_untimeout(sys_timeout_handler h, void *arg);
  80 #if NO_SYS
  81 void sys_check_timeouts(void);
  82 void sys_restart_timeouts(void);
  83 #else /* NO_SYS */
  84 void sys_timeouts_mbox_fetch(sys_mbox_t *mbox, void **msg);
  85 #endif /* NO_SYS */
  86
  87
  88 #ifdef __cplusplus
  89 }
  90 #endif
  91
  92 #endif /* __LWIP_TIMERS_H__ */