• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  *  Copyright (c) 2020, 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 URI_PATHS_HPP_
35 #define URI_PATHS_HPP_
36 
37 #include "openthread-core-config.h"
38 
39 namespace ot {
40 
41 /**
42  *
43  * This structure contains Thread URI Path string definitions.
44  *
45  */
46 struct UriPath
47 {
48     static const char kAddressQuery[];           ///< The URI Path for Address Query ("a/aq").
49     static const char kAddressNotify[];          ///< The URI Path for Address Notify ("a/an").
50     static const char kAddressError[];           ///< The URI Path for Address Error ("a/ae").
51     static const char kAddressRelease[];         ///< The URI Path for Address Release ("a/ar").
52     static const char kAddressSolicit[];         ///< The URI Path for Address Solicit ("a/as").
53     static const char kAnycastLocate[];          ///< The URI Path for Anycast Locate ("a/yl")
54     static const char kActiveGet[];              ///< The URI Path for MGMT_ACTIVE_GE ("c/ag")T
55     static const char kActiveSet[];              ///< The URI Path for MGMT_ACTIVE_SET ("c/as").
56     static const char kDatasetChanged[];         ///< The URI Path for MGMT_DATASET_CHANGED ("c/dc").
57     static const char kEnergyScan[];             ///< The URI Path for Energy Scan ("c/es").
58     static const char kEnergyReport[];           ///< The URI Path for Energy Report ("c/er").
59     static const char kPendingGet[];             ///< The URI Path for MGMT_PENDING_GET ("c/pg").
60     static const char kPendingSet[];             ///< The URI Path for MGMT_PENDING_SET ("c/ps").
61     static const char kServerData[];             ///< The URI Path for Server Data Registration ("a/sd").
62     static const char kAnnounceBegin[];          ///< The URI Path for Announce Begin ("c/ab").
63     static const char kProxyRx[];                ///< The URI Path for Proxy RX ("c/ur").
64     static const char kProxyTx[];                ///< The URI Path for Proxy TX ("c/ut").
65     static const char kRelayRx[];                ///< The URI Path for Relay RX ("c/rx").
66     static const char kRelayTx[];                ///< The URI Path for Relay TX ("c/tx").
67     static const char kJoinerFinalize[];         ///< The URI Path for Joiner Finalize ("c/jf").
68     static const char kJoinerEntrust[];          ///< The URI Path for Joiner Entrust ("c/je").
69     static const char kLeaderPetition[];         ///< The URI Path for Leader Petition ("c/lp").
70     static const char kLeaderKeepAlive[];        ///< The URI Path for Leader Keep Alive ("c/la").
71     static const char kPanIdConflict[];          ///< The URI Path for PAN ID Conflict ("c/pc").
72     static const char kPanIdQuery[];             ///< The URI Path for PAN ID Query ("c/pq").
73     static const char kCommissionerGet[];        ///< The URI Path for MGMT_COMMISSIONER_GET ("c/cg").
74     static const char kCommissionerKeepAlive[];  ///< The URI Path for Commissioner Keep Alive ("c/ca").
75     static const char kCommissionerPetition[];   ///< The URI Path for Commissioner Petition ("c/cp").
76     static const char kCommissionerSet[];        ///< The URI Path for MGMT_COMMISSIONER_SET ("c/cs").
77     static const char kDiagnosticGetRequest[];   ///< The URI Path for Network Diagnostic Get Request ("d/dg").
78     static const char kDiagnosticGetQuery[];     ///< The URI Path for Network Diagnostic Get Query ("d/dq").
79     static const char kDiagnosticGetAnswer[];    ///< The URI Path for Network Diagnostic Get Answer ("d/da").
80     static const char kDiagnosticReset[];        ///< The URI Path for Network Diagnostic Reset ("d/dr").
81     static const char kMlr[];                    ///< The URI Path for Multicast Listener Registration ("n/mr").
82     static const char kDuaRegistrationRequest[]; ///< The URI Path for DUA Registration Request ("n/dr").
83     static const char kDuaRegistrationNotify[];  ///< The URI Path for DUA Registration Notification ("n/dn").
84     static const char kBackboneQuery[];          ///< The URI Path for Backbone Query ("b/bq").
85     static const char kBackboneAnswer[];         ///< The URI Path for Backbone Answer / Backbone Notification ("b/ba").
86     static const char kBackboneMlr[];            ///< The URI Path for Backbone Multicast Listener Report ("b/bmr").
87 };
88 
89 } // namespace ot
90 
91 #endif // URI_PATHS_HPP_
92