third_party/ot-br-posix/repo/src/agent/uris.hpp

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