summaryrefslogtreecommitdiffstats
path: root/stacks/lwip_stack/release/lwip_helper_files/include/timeouts.h
blob: 005db52112086302db85ef34db8d1cece02a5bc6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/**
 * @file
 * Timer implementations
 */

/*
 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
 * This file is part of the lwIP TCP/IP stack.
 *
 * Author: Adam Dunkels <adam@sics.se>
 *         Simon Goldschmidt
 *
 */
#ifndef LWIP_HDR_TIMEOUTS_H
#define LWIP_HDR_TIMEOUTS_H

#include "lwip/opt.h"
#include "lwip/err.h"
#if !NO_SYS
#include "lwip/sys.h"
#endif

#ifdef __cplusplus
extern "C"
{
#endif

#ifndef LWIP_DEBUG_TIMERNAMES
#ifdef LWIP_DEBUG
#define LWIP_DEBUG_TIMERNAMES SYS_DEBUG
#else                           /* LWIP_DEBUG */
#define LWIP_DEBUG_TIMERNAMES 0
#endif                          /* LWIP_DEBUG */
#endif

/** Function prototype for a stack-internal timer function that has to be
 * called at a defined interval */
  typedef void (*lwip_cyclic_timer_handler) (void);

/** This struct contains information about a stack-internal timer function
 that has to be called at a defined interval */
  struct lwip_cyclic_timer
  {
    u32_t interval_ms;
    lwip_cyclic_timer_handler handler;
#if LWIP_DEBUG_TIMERNAMES
    const char *handler_name;
#endif                          /* LWIP_DEBUG_TIMERNAMES */
  };

/** This array contains all stack-internal cyclic timers. To get the number of
 * timers, use LWIP_ARRAYSIZE() */
  extern const struct lwip_cyclic_timer lwip_cyclic_timers[];

#if LWIP_TIMERS

/** Function prototype for a timeout callback function. Register such a function
 * using sys_timeout().
 *
 * @param arg Additional argument to pass to the function - set up by sys_timeout()
 */
  typedef void (*sys_timeout_handler) (void *arg);

  struct sys_timeo
  {
    struct sys_timeo *next;
    u32_t time;
    sys_timeout_handler h;
    void *arg;
#if LWIP_DEBUG_TIMERNAMES
    const char *handler_name;
#endif                          /* LWIP_DEBUG_TIMERNAMES */
  };

  void sys_timeouts_init (void);

#if LWIP_DEBUG_TIMERNAMES
  void sys_timeout_debug (u32_t msecs, sys_timeout_handler handler, void *arg,
                          const char *handler_name);
#define sys_timeout(msecs, handler, arg) sys_timeout_debug(msecs, handler, arg, #handler)
#else                           /* LWIP_DEBUG_TIMERNAMES */
  void sys_timeout (u32_t msecs, sys_timeout_handler handler, void *arg);
#endif                          /* LWIP_DEBUG_TIMERNAMES */

  void sys_untimeout (sys_timeout_handler handler, void *arg);
  void sys_restart_timeouts (void);
#if NO_SYS
  void sys_check_timeouts (void);
  u32_t sys_timeouts_sleeptime (void);
#else                           /* NO_SYS */
  void sys_timeouts_mbox_fetch (sys_mbox_t * mbox, void **msg);
#endif                          /* NO_SYS */

#else                           /* LWIP_TIMERS */
  typedef void (*sys_timeout_handler) (void *arg);

  void sys_timeouts_init (void);
  void sys_timeout (u32_t msecs, sys_timeout_handler handler, void *arg);
  void sys_untimeout (sys_timeout_handler handler, void *arg);
  void sys_timeouts_mbox_fetch (sys_mbox_t * mbox, void **msg);
  void cyclic_timer (void *arg);
  void tcpip_tcp_timer (void *arg);
  void tcp_timer_needed (void);

#endif
#ifdef __cplusplus
}
#endif

#endif                          /* LWIP_HDR_TIMEOUTS_H */