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 type definitions for OTBR-REST. 32 */ 33 34 #ifndef OTBR_REST_TYPES_HPP_ 35 #define OTBR_REST_TYPES_HPP_ 36 37 #include <chrono> 38 #include <string> 39 #include <vector> 40 41 #include "openthread/netdiag.h" 42 43 using std::chrono::steady_clock; 44 45 namespace otbr { 46 namespace rest { 47 48 enum class HttpMethod : std::uint8_t 49 { 50 kDelete = 0, ///< DELETE 51 kGet = 1, ///< GET 52 kHead = 2, ///< HEAD 53 kPost = 3, ///< POST 54 kPut = 4, ///< PUT 55 kOptions = 6, ///< OPTIONS 56 57 }; 58 59 enum class HttpStatusCode : std::uint16_t 60 { 61 kStatusOk = 200, 62 kStatusResourceNotFound = 404, 63 kStatusMethodNotAllowed = 405, 64 kStatusRequestTimeout = 408, 65 kStatusInternalServerError = 500, 66 }; 67 68 enum class PostError : std::uint8_t 69 { 70 kPostErrorNone = 0, ///< No error 71 kPostBadRequest = 1, ///< Bad request for post 72 kPostSetFail = 2, ///< Fail when set value 73 }; 74 75 enum class ConnectionState : std::uint8_t 76 { 77 kInit = 0, ///< Init 78 kReadWait = 1, ///< Wait to read 79 kReadTimeout = 2, ///< Reach read timeout 80 kCallbackWait = 3, ///< Wait for callback 81 kWriteWait = 4, ///< Wait for write 82 kWriteTimeout = 5, ///< Reach write timeout 83 kInternalError = 6, ///< Occur internal call error 84 kComplete = 7, ///< No longer need to be processed 85 86 }; 87 struct NodeInfo 88 { 89 uint32_t mRole; 90 uint32_t mNumOfRouter; 91 uint16_t mRloc16; 92 const uint8_t *mExtPanId; 93 const uint8_t *mExtAddress; 94 otIp6Address mRlocAddress; 95 otLeaderData mLeaderData; 96 std::string mNetworkName; 97 }; 98 99 struct DiagInfo 100 { 101 steady_clock::time_point mStartTime; 102 std::vector<otNetworkDiagTlv> mDiagContent; 103 }; 104 105 } // namespace rest 106 } // namespace otbr 107 108 #endif // OTBR_REST_TYPES_HPP_ 109