1 /*
2  *  Copyright (c) 2019, The OpenThread Authors.
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  * @brief
32  *  This file defines the OpenThread Backbone Router API (Thread 1.2)
33  */
34 
35 #ifndef OPENTHREAD_BACKBONE_ROUTER_H_
36 #define OPENTHREAD_BACKBONE_ROUTER_H_
37 
38 #include <openthread/instance.h>
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /**
45  * @addtogroup api-backbone-router
46  *
47  * @brief
48  *  This module includes functions for the OpenThread Backbone Router Service.
49  *
50  * @{
51  *
52  */
53 
54 /**
55  * Represents Backbone Router configuration.
56  *
57  */
58 typedef struct otBackboneRouterConfig
59 {
60     uint16_t mServer16;            ///< Only used when get Primary Backbone Router information in the Thread Network
61     uint16_t mReregistrationDelay; ///< Reregistration Delay (in seconds)
62     uint32_t mMlrTimeout;          ///< Multicast Listener Registration Timeout (in seconds)
63     uint8_t  mSequenceNumber;      ///< Sequence Number
64 } otBackboneRouterConfig;
65 
66 /**
67  * Gets the Primary Backbone Router information in the Thread Network.
68  *
69  * @param[in]   aInstance            A pointer to an OpenThread instance.
70  * @param[out]  aConfig              A pointer to where to put Primary Backbone Router information.
71  *
72  * @retval OT_ERROR_NONE              Successfully got Primary Backbone Router information.
73  * @retval OT_ERROR_NOT_FOUND         No Primary Backbone Router exists.
74  *
75  */
76 otError otBackboneRouterGetPrimary(otInstance *aInstance, otBackboneRouterConfig *aConfig);
77 
78 /**
79  * @}
80  *
81  */
82 
83 #ifdef __cplusplus
84 } // extern "C"
85 #endif
86 
87 #endif // OPENTHREAD_BACKBONE_ROUTER_H_
88