Daniel Peter / Net

lwip/include/lwip/timers.h@0:d616ece2d859, 2010-09-18 (annotated)

Committer:
mbed714
Date:
Sat Sep 18 23:05:49 2010 +0000
Revision:
0:d616ece2d859

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


mbed714

0:d616ece2d859


     1

/*





mbed714

0:d616ece2d859


     2

 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.





mbed714

0:d616ece2d859


     3

 * All rights reserved. 





mbed714

0:d616ece2d859


     4

 * 





mbed714

0:d616ece2d859


     5

 * Redistribution and use in source and binary forms, with or without modification, 





mbed714

0:d616ece2d859


     6

 * are permitted provided that the following conditions are met:





mbed714

0:d616ece2d859


     7

 *





mbed714

0:d616ece2d859


     8

 * 1. Redistributions of source code must retain the above copyright notice,





mbed714

0:d616ece2d859


     9

 *    this list of conditions and the following disclaimer.





mbed714

0:d616ece2d859


    10

 * 2. Redistributions in binary form must reproduce the above copyright notice,





mbed714

0:d616ece2d859


    11

 *    this list of conditions and the following disclaimer in the documentation





mbed714

0:d616ece2d859


    12

 *    and/or other materials provided with the distribution.





mbed714

0:d616ece2d859


    13

 * 3. The name of the author may not be used to endorse or promote products





mbed714

0:d616ece2d859


    14

 *    derived from this software without specific prior written permission. 





mbed714

0:d616ece2d859


    15

 *





mbed714

0:d616ece2d859


    16

 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 





mbed714

0:d616ece2d859


    17

 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 





mbed714

0:d616ece2d859


    18

 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 





mbed714

0:d616ece2d859


    19

 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 





mbed714

0:d616ece2d859


    20

 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 





mbed714

0:d616ece2d859


    21

 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 





mbed714

0:d616ece2d859


    22

 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 





mbed714

0:d616ece2d859


    23

 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 





mbed714

0:d616ece2d859


    24

 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 





mbed714

0:d616ece2d859


    25

 * OF SUCH DAMAGE.





mbed714

0:d616ece2d859


    26

 *





mbed714

0:d616ece2d859


    27

 * This file is part of the lwIP TCP/IP stack.





mbed714

0:d616ece2d859


    28

 * 





mbed714

0:d616ece2d859


    29

 * Author: Adam Dunkels <adam@sics.se>





mbed714

0:d616ece2d859


    30

 *         Simon Goldschmidt





mbed714

0:d616ece2d859


    31

 *





mbed714

0:d616ece2d859


    32

 */





mbed714

0:d616ece2d859


    33

#ifndef __LWIP_TIMERS_H__





mbed714

0:d616ece2d859


    34

#define __LWIP_TIMERS_H__





mbed714

0:d616ece2d859


    35







mbed714

0:d616ece2d859


    36

#include "lwip/opt.h"





mbed714

0:d616ece2d859


    37







mbed714

0:d616ece2d859


    38

/* Timers are not supported when NO_SYS==1 and NO_SYS_NO_TIMERS==1 */





mbed714

0:d616ece2d859


    39

#define LWIP_TIMERS (!NO_SYS || (NO_SYS && !NO_SYS_NO_TIMERS))





mbed714

0:d616ece2d859


    40







mbed714

0:d616ece2d859


    41

#if LWIP_TIMERS





mbed714

0:d616ece2d859


    42







mbed714

0:d616ece2d859


    43

#include "lwip/err.h"





mbed714

0:d616ece2d859


    44

#include "lwip/sys.h"





mbed714

0:d616ece2d859


    45







mbed714

0:d616ece2d859


    46

#ifdef __cplusplus





mbed714

0:d616ece2d859


    47

extern "C" {





mbed714

0:d616ece2d859


    48

#endif





mbed714

0:d616ece2d859


    49







mbed714

0:d616ece2d859


    50

#ifndef LWIP_DEBUG_TIMERNAMES





mbed714

0:d616ece2d859


    51

#ifdef LWIP_DEBUG





mbed714

0:d616ece2d859


    52

#define LWIP_DEBUG_TIMERNAMES SYS_DEBUG





mbed714

0:d616ece2d859


    53

#else /* LWIP_DEBUG */





mbed714

0:d616ece2d859


    54

#define LWIP_DEBUG_TIMERNAMES 0





mbed714

0:d616ece2d859


    55

#endif /* LWIP_DEBUG*/





mbed714

0:d616ece2d859


    56

#endif





mbed714

0:d616ece2d859


    57







mbed714

0:d616ece2d859


    58

/** Function prototype for a timeout callback function. Register such a function





mbed714

0:d616ece2d859


    59

 * using sys_timeout().





mbed714

0:d616ece2d859


    60

 *





mbed714

0:d616ece2d859


    61

 * @param arg Additional argument to pass to the function - set up by sys_timeout()





mbed714

0:d616ece2d859


    62

 */





mbed714

0:d616ece2d859


    63

typedef void (* sys_timeout_handler)(void *arg);





mbed714

0:d616ece2d859


    64







mbed714

0:d616ece2d859


    65

struct sys_timeo {





mbed714

0:d616ece2d859


    66

  struct sys_timeo *next;





mbed714

0:d616ece2d859


    67

  u32_t time;





mbed714

0:d616ece2d859


    68

  sys_timeout_handler h;





mbed714

0:d616ece2d859


    69

  void *arg;





mbed714

0:d616ece2d859


    70

#if LWIP_DEBUG_TIMERNAMES





mbed714

0:d616ece2d859


    71

  const char* handler_name;





mbed714

0:d616ece2d859


    72

#endif /* LWIP_DEBUG_TIMERNAMES */





mbed714

0:d616ece2d859


    73

};





mbed714

0:d616ece2d859


    74







mbed714

0:d616ece2d859


    75

void sys_timeouts_init(void);





mbed714

0:d616ece2d859


    76







mbed714

0:d616ece2d859


    77

#if LWIP_DEBUG_TIMERNAMES





mbed714

0:d616ece2d859


    78

void sys_timeout_debug(u32_t msecs, sys_timeout_handler handler, void *arg, const char* handler_name);





mbed714

0:d616ece2d859


    79

#define sys_timeout(msecs, handler, arg) sys_timeout_debug(msecs, handler, arg, #handler)





mbed714

0:d616ece2d859


    80

#else /* LWIP_DEBUG_TIMERNAMES */





mbed714

0:d616ece2d859


    81

void sys_timeout(u32_t msecs, sys_timeout_handler handler, void *arg);





mbed714

0:d616ece2d859


    82

#endif /* LWIP_DEBUG_TIMERNAMES */





mbed714

0:d616ece2d859


    83







mbed714

0:d616ece2d859


    84

void sys_untimeout(sys_timeout_handler handler, void *arg);





mbed714

0:d616ece2d859


    85

#if NO_SYS





mbed714

0:d616ece2d859


    86

void sys_check_timeouts(void);





mbed714

0:d616ece2d859


    87

void sys_restart_timeouts(void);





mbed714

0:d616ece2d859


    88

#else /* NO_SYS */





mbed714

0:d616ece2d859


    89

void sys_timeouts_mbox_fetch(sys_mbox_t *mbox, void **msg);





mbed714

0:d616ece2d859


    90

#endif /* NO_SYS */





mbed714

0:d616ece2d859


    91







mbed714

0:d616ece2d859


    92







mbed714

0:d616ece2d859


    93

#ifdef __cplusplus





mbed714

0:d616ece2d859


    94

}





mbed714

0:d616ece2d859


    95

#endif





mbed714

0:d616ece2d859


    96







mbed714

0:d616ece2d859


    97

#endif /* LWIP_TIMERS */





mbed714

0:d616ece2d859


    98

#endif /* __LWIP_TIMERS_H__ */