aa49c9d3a868afdf43620cdd05b248dffa6730e6
[oonf.git] / include / oonf / nhdp / nhdp / nhdp_hysteresis.h
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 #ifndef NHDP_HYSTERESIS_H_
47 #define NHDP_HYSTERESIS_H_
48
49 #include <oonf/oonf.h>
50 #include <oonf/subsystems/oonf_rfc5444.h>
51
52 #include <oonf/nhdp/nhdp/nhdp_db.h>
53
54 /**
55  * Output buffer for hysteresis data string representation
56  */
57 struct nhdp_hysteresis_str {
58   /*! text buffer for maximum length string representation */
59   char buf[128];
60 };
61
62 /**
63  * NHDP link hysteresis handler
64  */
65 struct nhdp_hysteresis_handler {
66   /*! name of the handler */
67   const char *name;
68
69   /**
70    * callback to update link hysteresis pending and lost status.
71    * Some implementations might also change their internal state
72    * @param lnk nhdp link
73    * @param context rfc5444 reader context
74    */
75   void (*update_hysteresis)(struct nhdp_link *lnk, struct rfc5444_reader_tlvblock_context *context);
76
77   /**
78    * callback to check if link is pending
79    * @param lnk nhdp link
80    * @return true if link is pending
81    */
82   bool (*is_pending)(struct nhdp_link *lnk);
83
84   /**
85    * callback to check if link is lost
86    * @param lnk nhdp link
87    * @return true if link is lost
88    */
89   bool (*is_lost)(struct nhdp_link *lnk);
90
91   /**
92    * callback to convert hysteresis state into string representation
93    * @param buf buffer for text output
94    * @param lnk nhdp link
95    * @return pointer to buffer
96    */
97   const char *(*to_string)(struct nhdp_hysteresis_str *buf, struct nhdp_link *lnk);
98 };
99
100 EXPORT void nhdp_hysteresis_set_handler(struct nhdp_hysteresis_handler *);
101 EXPORT struct nhdp_hysteresis_handler *nhdp_hysteresis_get_handler(void);
102
103 /**
104  * Update a links hysteresis because of an incoming NHDP Hello message
105  * @param lnk pointer to NHDP link
106  * @param context pointer to rfc5444 context (message context)
107  */
108 static INLINE void
109 nhdp_hysteresis_update(struct nhdp_link *lnk, struct rfc5444_reader_tlvblock_context *context) {
110   nhdp_hysteresis_get_handler()->update_hysteresis(lnk, context);
111 }
112
113 /**
114  * @param lnk pointer to nhdp link
115  * @return true if link is pending
116  */
117 static INLINE bool
118 nhdp_hysteresis_is_pending(struct nhdp_link *lnk) {
119   return nhdp_hysteresis_get_handler()->is_pending(lnk);
120 }
121
122 /**
123  * @param lnk pointer to nhdp link
124  * @return true if link is lost
125  */
126 static INLINE bool
127 nhdp_hysteresis_is_lost(struct nhdp_link *lnk) {
128   return nhdp_hysteresis_get_handler()->is_lost(lnk);
129 }
130
131 /**
132  * @param buf pointer to nhdp hysteresis text buffer
133  * @param lnk pointer to nhdp link
134  * @return pointer to text description of nhdp links hysteresis status
135  */
136 static INLINE const char *
137 nhdp_hysteresis_to_string(struct nhdp_hysteresis_str *buf, struct nhdp_link *lnk) {
138   return nhdp_hysteresis_get_handler()->to_string(buf, lnk);
139 }
140
141 #endif /* NHDP_HYSTERESIS_H_ */