info: java: update workspace
[olsrd.git] / src / mantissa.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon (olsrd)
3  *
4  * (c) by the OLSR project
5  *
6  * See our Git repository to find out who worked on this file
7  * and thus is a copyright holder on it.
8  *
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright
16  *   notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above copyright
18  *   notice, this list of conditions and the following disclaimer in
19  *   the documentation and/or other materials provided with the
20  *   distribution.
21  * * Neither the name of olsr.org, olsrd nor the names of its
22  *   contributors may be used to endorse or promote products derived
23  *   from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  *
38  * Visit http://www.olsr.org for more information.
39  *
40  * If you find this software useful feel free to make a donation
41  * to the project. For more information see the website or contact
42  * the copyright holders.
43  *
44  */
45
46 #ifndef _OLSR_MANTISSA
47 #define _OLSR_MANTISSA
48
49 #include "olsr_types.h"
50
51 /* olsr_reltime is a relative timestamp measured in microseconds */
52 typedef uint32_t olsr_reltime;
53
54 /**
55  * Macro for converting a mantissa/exponent 8bit value back
56  * to an integer (measured in microseconds) as described in RFC3626:
57  *
58  * value = C*(1+a/16)*2^b [in seconds]
59  *
60  *  where a is the integer represented by the four highest bits of the
61  *  field and b the integer represented by the four lowest bits of the
62  *  field.
63  *
64  * me is the 8 bit mantissa/exponent value
65  *
66  */
67 olsr_reltime me_to_reltime(const uint8_t);
68
69 uint8_t reltime_to_me(const olsr_reltime);
70
71 olsr_reltime reltime_minimum_interval(void);
72
73 #endif /* _OLSR_MANTISSA */
74
75 /*
76  * Local Variables:
77  * c-basic-offset: 2
78  * indent-tabs-mode: nil
79  * End:
80  */