/Users/deen/code/yugabyte-db/src/yb/client/client_error.h
Line | Count | Source |
1 | | // Copyright (c) YugaByte, Inc. |
2 | | // |
3 | | // Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except |
4 | | // in compliance with the License. You may obtain a copy of the License at |
5 | | // |
6 | | // http://www.apache.org/licenses/LICENSE-2.0 |
7 | | // |
8 | | // Unless required by applicable law or agreed to in writing, software distributed under the License |
9 | | // is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express |
10 | | // or implied. See the License for the specific language governing permissions and limitations |
11 | | // under the License. |
12 | | // |
13 | | |
14 | | #ifndef YB_CLIENT_CLIENT_ERROR_H |
15 | | #define YB_CLIENT_CLIENT_ERROR_H |
16 | | |
17 | | #include "yb/util/enums.h" |
18 | | #include "yb/util/math_util.h" |
19 | | #include "yb/util/status.h" |
20 | | #include "yb/util/status_ec.h" |
21 | | |
22 | | namespace yb { |
23 | | namespace client { |
24 | | |
25 | | YB_DEFINE_ENUM( |
26 | | ClientErrorCode, |
27 | | // Special value used to indicate no error of this type. |
28 | | (kNone) |
29 | | (kTablePartitionListIsStale) |
30 | | (kExpiredRequestToBeRetried) |
31 | | (kTabletNotYetRunning) |
32 | | (kTablePartitionListVersionDoesNotMatch) |
33 | | (kMetaCacheInvalidated) |
34 | | ); |
35 | | |
36 | | struct ClientErrorTag : IntegralErrorTag<ClientErrorCode> { |
37 | | // It is part of the wire protocol and should not be changed once released. |
38 | | static constexpr uint8_t kCategory = 12; |
39 | | |
40 | 3 | static std::string ToMessage(Value value) { |
41 | 3 | return ToString(value); |
42 | 3 | } |
43 | | }; |
44 | | |
45 | | typedef StatusErrorCodeImpl<ClientErrorTag> ClientError; |
46 | | |
47 | | // Returns whether status is a client error that should be retried at YBSession level internally. |
48 | | // If status is OK, also returns false. |
49 | | bool IsRetryableClientError(const Status& status); |
50 | | |
51 | | } // namespace client |
52 | | } // namespace yb |
53 | | |
54 | | #endif // YB_CLIENT_CLIENT_ERROR_H |