xref: /aosp_15_r20/external/ot-br-posix/src/agent/uris.hpp (revision 4a64e381480ef79f0532b2421e44e6ee336b8e0d)
1 /*
2  *  Copyright (c) 2016-2017, 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  *   This file includes definitions for Thread URIs.
32  */
33 
34 #ifndef OTBR_AGENT_THREAD_URIS_HPP_
35 #define OTBR_AGENT_THREAD_URIS_HPP_
36 
37 namespace otbr {
38 
39 /**
40  * The URI Path for Address Query.
41  */
42 #define OT_URI_PATH_ADDRESS_QUERY "a/aq"
43 
44 /**
45  * @def OT_URI_PATH_ADDRESS_NOTIFY
46  *
47  * The URI Path for Address Notify.
48  */
49 #define OT_URI_PATH_ADDRESS_NOTIFY "a/an"
50 
51 /**
52  * @def OT_URI_PATH_ADDRESS_ERROR
53  *
54  * The URI Path for Address Error.
55  */
56 #define OT_URI_PATH_ADDRESS_ERROR "a/ae"
57 
58 /**
59  * @def OT_URI_PATH_ADDRESS_RELEASE
60  *
61  * The URI Path for Address Release.
62  */
63 #define OT_URI_PATH_ADDRESS_RELEASE "a/ar"
64 
65 /**
66  * @def OT_URI_PATH_ADDRESS_SOLICIT
67  *
68  * The URI Path for Address Solicit.
69  */
70 #define OT_URI_PATH_ADDRESS_SOLICIT "a/as"
71 
72 /**
73  * @def OT_URI_PATH_ACTIVE_GET
74  *
75  * The URI Path for MGMT_ACTIVE_GET
76  */
77 #define OT_URI_PATH_ACTIVE_GET "c/ag"
78 
79 /**
80  * @def OT_URI_PATH_ACTIVE_SET
81  *
82  * The URI Path for MGMT_ACTIVE_SET
83  */
84 #define OT_URI_PATH_ACTIVE_SET "c/as"
85 
86 /**
87  * @def OT_URI_PATH_DATASET_CHANGED
88  *
89  * The URI Path for MGMT_DATASET_CHANGED
90  */
91 #define OT_URI_PATH_DATASET_CHANGED "c/dc"
92 
93 /**
94  * @def OT_URI_PATH_ENERGY_SCAN
95  *
96  * The URI Path for Energy Scan
97  */
98 #define OT_URI_PATH_ENERGY_SCAN "c/es"
99 
100 /**
101  * @def OT_URI_PATH_ENERGY_REPORT
102  *
103  * The URI Path for Energy Report
104  */
105 #define OT_URI_PATH_ENERGY_REPORT "c/er"
106 
107 /**
108  * @def OT_URI_PATH_PENDING_GET
109  *
110  * The URI Path for MGMT_PENDING_GET
111  */
112 #define OT_URI_PATH_PENDING_GET "c/pg"
113 
114 /**
115  * @def OT_URI_PATH_PENDING_SET
116  *
117  * The URI Path for MGMT_PENDING_SET
118  */
119 #define OT_URI_PATH_PENDING_SET "c/ps"
120 
121 /**
122  * @def OT_URI_PATH_SERVER_DATA
123  *
124  * The URI Path for Server Data Registration.
125  */
126 #define OT_URI_PATH_SERVER_DATA "a/sd"
127 
128 /**
129  * @def OT_URI_PATH_ANNOUNCE_BEGIN
130  *
131  * The URI Path for Announce Begin.
132  */
133 #define OT_URI_PATH_ANNOUNCE_BEGIN "c/ab"
134 
135 /**
136  * @def OT_URI_PATH_RELAY_RX
137  *
138  * The URI Path for Relay RX.
139  */
140 #define OT_URI_PATH_RELAY_RX "c/rx"
141 
142 /**
143  * @def OT_URI_PATH_RELAY_TX
144  *
145  * The URI Path for Relay TX.
146  */
147 #define OT_URI_PATH_RELAY_TX "c/tx"
148 
149 /**
150  * @def OT_URI_PATH_JOINER_FINALIZE
151  *
152  * The URI Path for Joiner Finalize
153  */
154 #define OT_URI_PATH_JOINER_FINALIZE "c/jf"
155 
156 /**
157  * @def OT_URI_PATH_JOINER_ENTRUST
158  *
159  * The URI Path for Joiner Entrust
160  */
161 #define OT_URI_PATH_JOINER_ENTRUST "c/je"
162 
163 /**
164  * @def OT_URI_PATH_LEADER_PETITION
165  *
166  * The URI Path for Leader Petition
167  */
168 #define OT_URI_PATH_LEADER_PETITION "c/lp"
169 
170 /**
171  * @def OT_URI_PATH_LEADER_KEEP_ALIVE
172  *
173  * The URI Path for Leader Keep Alive
174  */
175 #define OT_URI_PATH_LEADER_KEEP_ALIVE "c/la"
176 
177 /**
178  * @def OT_URI_PATH_PANID_CONFLICT
179  *
180  * The URI Path for PAN ID Conflict
181  */
182 #define OT_URI_PATH_PANID_CONFLICT "c/pc"
183 
184 /**
185  * @def OT_URI_PATH_PANID_QUERY
186  *
187  * The URI Path for PAN ID Query
188  */
189 #define OT_URI_PATH_PANID_QUERY "c/pq"
190 
191 /**
192  * @def OT_URI_PATH_COMMISSIONER_GET
193  *
194  * The URI Path for MGMT_COMMISSIONER_GET
195  */
196 #define OT_URI_PATH_COMMISSIONER_GET "c/cg"
197 
198 /**
199  * @def OT_URI_PATH_COMMISSIONER_SET
200  *
201  * The URI Path for MGMT_COMMISSIONER_SET
202  */
203 #define OT_URI_PATH_COMMISSIONER_SET "c/cs"
204 
205 /**
206  * @def OT_URI_PATH_COMMISSIONER_PETITION
207  *
208  * The URI Path for Commissioner Petition.
209  */
210 #define OT_URI_PATH_COMMISSIONER_PETITION "c/cp"
211 
212 /**
213  * @def OT_URI_PATH_COMMISSIONER_KEEP_ALIVE
214  *
215  * The URI Path for Commissioner Keep Alive.
216  */
217 #define OT_URI_PATH_COMMISSIONER_KEEP_ALIVE "c/ca"
218 
219 /**
220  * @def OT_URI_PATH_DIAGNOSTIC_GET_REQUEST
221  *
222  * The URI Path for Network Diagnostic Get Request.
223  */
224 #define OT_URI_PATH_DIAGNOSTIC_GET_REQUEST "d/dg"
225 
226 /**
227  * @def OT_URI_PATH_DIAGNOSTIC_GET_QUERY
228  *
229  * The URI Path for Network Diagnostic Get Query.
230  */
231 #define OT_URI_PATH_DIAGNOSTIC_GET_QUERY "d/dq"
232 
233 /**
234  * @def OT_URI_PATH_DIAGNOSTIC_GET_ANSWER
235  *
236  * The URI Path for Network Diagnostic Get Answer.
237  */
238 #define OT_URI_PATH_DIAGNOSTIC_GET_ANSWER "d/da"
239 
240 /**
241  * @def OT_URI_PATH_DIAG_RST
242  *
243  * The URI Path for Network Diagnostic Reset.
244  */
245 #define OT_URI_PATH_DIAGNOSTIC_RESET "d/dr"
246 
247 } // namespace otbr
248 
249 #endif // OTBR_AGENT_THREAD_URIS_HPP_
250