1 /*
2  *  Copyright (c) 2018, 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 includes functions for the Thread Border Agent role.
33  */
34 
35 #ifndef OPENTHREAD_BORDER_AGENT_H_
36 #define OPENTHREAD_BORDER_AGENT_H_
37 
38 #include <openthread/instance.h>
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /**
45  * @addtogroup api-border-agent
46  *
47  * @brief
48  *   This module includes functions for the Thread Border Agent role.
49  *
50  * @{
51  *
52  */
53 
54 /**
55  * This enumeration defines the Border Agent state.
56  *
57  */
58 typedef enum otBorderAgentState
59 {
60     OT_BORDER_AGENT_STATE_STOPPED = 0, ///< Border agent role is disabled.
61     OT_BORDER_AGENT_STATE_STARTED = 1, ///< Border agent is started.
62     OT_BORDER_AGENT_STATE_ACTIVE  = 2, ///< Border agent is connected with external commissioner.
63 } otBorderAgentState;
64 
65 /**
66  * This function gets the state of Thread Border Agent role.
67  *
68  * @param[in]  aInstance  A pointer to an OpenThread instance.
69  *
70  * @returns State of the Border Agent.
71  *
72  */
73 otBorderAgentState otBorderAgentGetState(otInstance *aInstance);
74 
75 /**
76  * This function gets the UDP port of Thread Border Agent service.
77  *
78  * @param[in]  aInstance  A pointer to an OpenThread instance.
79  *
80  * @returns UDP port of the Border Agent.
81  *
82  */
83 uint16_t otBorderAgentGetUdpPort(otInstance *aInstance);
84 
85 /**
86  * @}
87  *
88  */
89 
90 #ifdef __cplusplus
91 } // end of extern "C"
92 #endif
93 
94 #endif // OPENTHREAD_BORDER_AGENT_H_
95