types.hpp

Go to the documentation of this file.

/*
 *  Copyright (c) 2020, The OpenThread Authors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef OTBR_REST_TYPES_HPP_
#define OTBR_REST_TYPES_HPP_
 
#include <chrono>
#include <string>
#include <vector>
 
#include "openthread/netdiag.h"
 
using std::chrono::steady_clock;
 
namespace otbr {
namespace rest {
 
enum class HttpMethod : std::uint8_t
{
    kDelete  = 0, 
    kGet     = 1, 
    kHead    = 2, 
    kPost    = 3, 
    kPut     = 4, 
    kOptions = 6, 
 
};
 
enum class HttpStatusCode : std::uint16_t
{
    kStatusOk                  = 200,
    kStatusResourceNotFound    = 404,
    kStatusMethodNotAllowed    = 405,
    kStatusRequestTimeout      = 408,
    kStatusInternalServerError = 500,
};
 
enum class PostError : std::uint8_t
{
    kPostErrorNone  = 0, 
    kPostBadRequest = 1, 
    kPostSetFail    = 2, 
};
 
enum class ConnectionState : std::uint8_t
{
    kInit          = 0, 
    kReadWait      = 1, 
    kReadTimeout   = 2, 
    kCallbackWait  = 3, 
    kWriteWait     = 4, 
    kWriteTimeout  = 5, 
    kInternalError = 6, 
    kComplete      = 7, 
 
};
struct NodeInfo
{
    uint32_t       mRole;
    uint32_t       mNumOfRouter;
    uint16_t       mRloc16;
    const uint8_t *mExtPanId;
    const uint8_t *mExtAddress;
    otIp6Address   mRlocAddress;
    otLeaderData   mLeaderData;
    std::string    mNetworkName;
};
 
struct DiagInfo
{
    steady_clock::time_point      mStartTime;
    std::vector<otNetworkDiagTlv> mDiagContent;
};
 
} // namespace rest
} // namespace otbr
 
#endif // OTBR_REST_TYPES_HPP_