Rename "subsystems" directory to "base"
[oonf.git] / src / nhdp / nhdp / nhdp_hysteresis.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon version 2 (olsrd2)
4  * Copyright (c) 2004-2015, 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 /**
43  * @file
44  */
45
46 #include <oonf/oonf.h>
47 #include <oonf/libcore/oonf_logging.h>
48 #include <oonf/base/oonf_rfc5444.h>
49
50 #include <oonf/nhdp/nhdp/nhdp_db.h>
51 #include <oonf/nhdp/nhdp/nhdp_hysteresis.h>
52
53 /* prototypes */
54 static void _update_hysteresis(struct nhdp_link *lnk, struct rfc5444_reader_tlvblock_context *context);
55 static bool _is_pending(struct nhdp_link *);
56 static bool _is_lost(struct nhdp_link *);
57 static const char *_to_string(struct nhdp_hysteresis_str *buf, struct nhdp_link *lnk);
58
59 /* default handler */
60 static struct nhdp_hysteresis_handler _handler = {
61   .name = "No NHDP hysteresis",
62   .update_hysteresis = _update_hysteresis,
63   .is_pending = _is_pending,
64   .is_lost = _is_lost,
65   .to_string = _to_string,
66 };
67
68 /* hysteresis handler */
69 static struct nhdp_hysteresis_handler *nhdp_hysteresis = &_handler;
70
71 /**
72  * Set new handler hysteresis handler
73  * @param handler pointer to handler, NULL to reset to default
74  */
75 void
76 nhdp_hysteresis_set_handler(struct nhdp_hysteresis_handler *handler) {
77   if (handler == NULL) {
78     nhdp_hysteresis = &_handler;
79   }
80   else {
81     nhdp_hysteresis = handler;
82   }
83 }
84
85 /**
86  * @return current nhdp hysteresis handler
87  */
88 struct nhdp_hysteresis_handler *
89 nhdp_hysteresis_get_handler(void) {
90   return nhdp_hysteresis;
91 }
92
93 /**
94  * Dummy function for hysteresis update (does nothing)
95  * @param lnk NHDP link
96  * @param context RFC5444 tlvblock reader context
97  */
98 static void
99 _update_hysteresis(struct nhdp_link *lnk __attribute__((unused)),
100   struct rfc5444_reader_tlvblock_context *context __attribute__((unused))) {
101   /* do nothing */
102   return;
103 }
104
105 /**
106  * Dummy function for testing if link is pending
107  * @param lnk pointer to link
108  * @return always false
109  */
110 static bool
111 _is_pending(struct nhdp_link *lnk __attribute((unused))) {
112   return false;
113 }
114
115 /**
116  * Dummy function for testing if link is lost
117  * @param lnk pointer to link
118  * @return always false
119  */
120 static bool
121 _is_lost(struct nhdp_link *lnk __attribute__((unused))) {
122   return false;
123 }
124
125 /**
126  * Dummy function to create text representation of
127  * hysteresis data.
128  * @param buf pointer to output buffer
129  * @param lnk pointer to link to describe in text
130  * @return always returns pointer to empty string
131  */
132 static const char *
133 _to_string(struct nhdp_hysteresis_str *buf, struct nhdp_link *lnk __attribute__((unused))) {
134   buf->buf[0] = 0;
135   return buf->buf;
136 }