~aleteoryx/muditaos

ref: 25a5d90f4e12ee5d33f4202170f18b59e16a9564 muditaos/module-cellular/at/Result.hpp -rw-r--r-- 2.2 KiB
25a5d90f — rrandomsky [CP-2156] Fixed no response when editing a contact to have the same number as another 2 years ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
// Copyright (c) 2017-2021, Mudita Sp. z.o.o. All rights reserved.
// For licensing, see https://github.com/mudita/MuditaOS/LICENSE.md

#pragma once

#include <variant>
#include <string>
#include <vector>

#include <ErrorCode.hpp>

namespace at
{
    struct Result
    {
        /// result class for AT send -> receive command, could return promise :p
        enum class Code
        {
            OK,              /// at OK
            ERROR,           /// at ERROR For compatibility also for CME_ERROR and CMS_ERROR (details in errorCode)
            CME_ERROR,       /// In case CME error see errorCode
            CMS_ERROR,       /// In case CMS error see errorCode
            TIMEOUT,         /// at Timeout
            TOKENS,          /// at numbers of tokens needed met
            NONE,            /// no code
            UNDEFINED,       /// undefined result - usage of Undefined result, define and pin result to use it
            PARSING_ERROR,   /// parser error
            FULL_MSG_BUFFER, /// at not enough space left in message buffer for new message
            TRANSMISSION_NOT_STARTED, /// at dma not starting transmission
            RECEIVING_NOT_STARTED,    /// at dma not starting requested receiving
            DATA_NOT_USED,            /// at received data not being used
            CMUX_FRAME_ERROR,         /// at cmux deserialize error
        } code = Code::UNDEFINED;

        Result() = default;

        Result(Code code, std::vector<std::string> response) : code(code), response(std::move(response))
        {}

        //! Information about Equipment or Network error as variant type
        /*!
         * Example of checking for specific error type
            if (std::holds_alternative<at::EquipmentErrorCode>(errorCode)){
                std::get<at::EquipmentErrorCode>(errorCode);
            }
        */
        std::variant<at::EquipmentErrorCode, at::NetworkErrorCode> errorCode = at::EquipmentErrorCode::NoInformation;

        std::vector<std::string> response;
        std::vector<std::vector<std::string>> tokens;

        virtual explicit operator bool() const
        {
            return code == Code::OK;
        }

        virtual ~Result() = default;
    };
} // namespace at