aboutsummaryrefslogtreecommitdiffstats
path: root/storage/src/vespa/storageapi/messageapi/returncode.cpp
blob: d3e321b11b6ca318e7f39c03aa826ad7465c6e2b (plain) (blame)
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include "returncode.h"
#include <ostream>

namespace storage::api {

ReturnCode & ReturnCode::operator = (ReturnCode &&) noexcept = default;

ReturnCode::ReturnCode(Result result, vespalib::stringref msg)
    : _result(result),
      _message()
{
    if ( ! msg.empty()) {
        _message = std::make_unique<vespalib::string>(msg);
    }
}

ReturnCode::ReturnCode(const ReturnCode & rhs)
    : _result(rhs._result),
      _message()
{
    if (rhs._message) {
        _message = std::make_unique<vespalib::string>(*rhs._message);
    }
}

ReturnCode &
ReturnCode::operator = (const ReturnCode & rhs) {
    return operator=(ReturnCode(rhs));
}

vespalib::string
ReturnCode::getResultString(Result result) {
    return documentapi::DocumentProtocol::getErrorName(result);
}

vespalib::string
ReturnCode::toString() const {
    vespalib::string ret = "ReturnCode(";
    ret += getResultString(_result);
    if ( _message && ! _message->empty()) {
        ret += ", ";
        ret += *_message;
    }
    ret += ")";
    return ret;
}

std::ostream &
operator << (std::ostream & os, const ReturnCode & returnCode) {
    return os << returnCode.toString();
}

bool
ReturnCode::isBusy() const
{
    // Casting to suppress -Wswitch since we're comparing against enum values
    // not present in the ReturnCode::Result enum.
    switch (static_cast<uint32_t>(_result)) {
        case mbus::ErrorCode::SEND_QUEUE_FULL:
        case mbus::ErrorCode::SESSION_BUSY:
        case mbus::ErrorCode::TIMEOUT:
        case Protocol::ERROR_BUSY:
            return true;
        default:
            return false;
    }
}

bool
ReturnCode::isNodeDownOrNetwork() const
{
    switch (static_cast<uint32_t>(_result)) {
        case mbus::ErrorCode::NO_ADDRESS_FOR_SERVICE:
        case mbus::ErrorCode::CONNECTION_ERROR:
        case mbus::ErrorCode::UNKNOWN_SESSION:
        case mbus::ErrorCode::HANDSHAKE_FAILED:
        case mbus::ErrorCode::NO_SERVICES_FOR_ROUTE:
        case mbus::ErrorCode::NETWORK_ERROR:
        case mbus::ErrorCode::UNKNOWN_PROTOCOL:
        case Protocol::ERROR_NODE_NOT_READY:
        case Protocol::ERROR_NOT_CONNECTED:
            return true;
        default:
            return false;
    }
}

bool
ReturnCode::isCriticalForMaintenance() const
{
    if (_result >= static_cast<uint32_t>(mbus::ErrorCode::FATAL_ERROR)) {
        return true;
    }

    switch (static_cast<uint32_t>(_result)) {
        case Protocol::ERROR_INTERNAL_FAILURE:
        case Protocol::ERROR_NO_SPACE:
        case Protocol::ERROR_UNPARSEABLE:
        case Protocol::ERROR_ILLEGAL_PARAMETERS:
        case Protocol::ERROR_NOT_IMPLEMENTED:
        case Protocol::ERROR_UNKNOWN_COMMAND:
        case Protocol::ERROR_PROCESSING_FAILURE:
        case Protocol::ERROR_IGNORED:
            return true;
        default:
            return false;
    }
}

bool
ReturnCode::isCriticalForVisitor() const
{
    return isCriticalForMaintenance();
}

bool
ReturnCode::isCriticalForVisitorDispatcher() const
{
    return isCriticalForMaintenance();
}

bool
ReturnCode::isNonCriticalForIntegrityChecker() const
{
    switch (static_cast<uint32_t>(_result)) {
        case Protocol::ERROR_ABORTED:
        case Protocol::ERROR_BUCKET_DELETED:
        case Protocol::ERROR_BUCKET_NOT_FOUND:
            return true;
        default:
            return false;
    }
}

bool
ReturnCode::isShutdownRelated() const
{
    switch (static_cast<uint32_t>(_result)) {
        case Protocol::ERROR_ABORTED:
            return true;
        default:
            return false;
    }
}

bool
ReturnCode::isBucketDisappearance() const
{
    switch (static_cast<uint32_t>(_result)) {
        case Protocol::ERROR_BUCKET_NOT_FOUND:
        case Protocol::ERROR_BUCKET_DELETED:
            return true;
        default:
            return false;
    }
}

bool
ReturnCode::operator==(const ReturnCode& code) const {
    return (_result == code._result) && (getMessage() == code.getMessage());
}

bool
ReturnCode::operator!=(const ReturnCode& code) const {
    return (_result != code._result) || (getMessage() != code.getMessage());
}
}