Allow dynamic linking of framework to application
[oonf.git] / src / core / olsr_clock.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2011, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #ifndef _OLSR_CLOCK
43 #define _OLSR_CLOCK
44
45 #include "common/common_types.h"
46
47 /* Some defs for juggling with timers */
48 #define MSEC_PER_SEC 1000
49 #define USEC_PER_SEC 1000000
50 #define NSEC_PER_USEC 1000
51 #define USEC_PER_MSEC 1000
52
53 struct millitxt_buf {
54   char buf[sizeof("4000000.000")];
55 };
56
57 /* buffer for displaying absolute timestamps */
58 struct timeval_buf {
59   char buf[sizeof("00:00:00.000000")];
60 };
61
62 EXPORT int olsr_clock_init(void) __attribute__((warn_unused_result));
63 EXPORT void olsr_clock_cleanup(void);
64 EXPORT int olsr_clock_update(void) __attribute__((warn_unused_result));
65
66 EXPORT int32_t olsr_clock_getRelative(uint32_t absolute);
67 EXPORT bool olsr_clock_isPast(uint32_t s);
68 EXPORT uint32_t olsr_clock_getNow(void);
69
70 EXPORT uint32_t olsr_clock_decode_olsrv1(const uint8_t);
71 EXPORT uint8_t olsr_clock_encode_olsrv1(const uint32_t);
72
73 EXPORT char *olsr_clock_to_string(struct millitxt_buf *buffer, uint32_t t);
74 EXPORT uint32_t olsr_clock_parse_string(char *txt);
75
76 EXPORT const char *olsr_clock_toClockString(struct timeval_buf *, uint32_t);
77 EXPORT const char *olsr_clock_getWallclockString(struct timeval_buf *);
78
79 /**
80  * Returns a timestamp s seconds in the future
81  * @param s milliseconds until timestamp
82  * @return absolute time when event will happen
83  */
84 static inline uint32_t
85 olsr_clock_get_absolute(uint32_t relative)
86 {
87   return olsr_clock_getNow() + relative;
88 }
89
90 #endif
91
92 /*
93  * Local Variables:
94  * c-basic-offset: 2
95  * indent-tabs-mode: nil
96  * End:
97  */