GRPC C++  1.50.0
status.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright 2016 gRPC authors.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  */
18 
19 #ifndef GRPCPP_IMPL_CODEGEN_STATUS_H
20 #define GRPCPP_IMPL_CODEGEN_STATUS_H
21 
22 // IWYU pragma: private, include <grpcpp/support/status.h>
23 
25 
29 
30 namespace grpc {
31 
36  public:
38  Status() : code_(StatusCode::OK) {
39  // Static assertions to make sure that the C++ API value correctly
40  // maps to the core surface API value
41  static_assert(StatusCode::OK == static_cast<StatusCode>(GRPC_STATUS_OK),
42  "Mismatched status code");
43  static_assert(
45  "Mismatched status code");
46  static_assert(
48  "Mismatched status code");
49  static_assert(StatusCode::INVALID_ARGUMENT ==
51  "Mismatched status code");
52  static_assert(StatusCode::DEADLINE_EXCEEDED ==
54  "Mismatched status code");
55  static_assert(
57  "Mismatched status code");
58  static_assert(StatusCode::ALREADY_EXISTS ==
60  "Mismatched status code");
61  static_assert(StatusCode::PERMISSION_DENIED ==
63  "Mismatched status code");
64  static_assert(StatusCode::UNAUTHENTICATED ==
66  "Mismatched status code");
67  static_assert(StatusCode::RESOURCE_EXHAUSTED ==
69  "Mismatched status code");
70  static_assert(StatusCode::FAILED_PRECONDITION ==
72  "Mismatched status code");
73  static_assert(
75  "Mismatched status code");
76  static_assert(StatusCode::OUT_OF_RANGE ==
78  "Mismatched status code");
79  static_assert(StatusCode::UNIMPLEMENTED ==
81  "Mismatched status code");
82  static_assert(
84  "Mismatched status code");
85  static_assert(StatusCode::UNAVAILABLE ==
86  static_cast<StatusCode>(GRPC_STATUS_UNAVAILABLE),
87  "Mismatched status code");
88  static_assert(
90  "Mismatched status code");
91  }
92 
99  Status(StatusCode code, const std::string& error_message)
100  : code_(code), error_message_(error_message) {}
101 
105  Status(StatusCode code, const std::string& error_message,
106  const std::string& error_details)
107  : code_(code),
108  error_message_(error_message),
109  binary_error_details_(error_details) {}
110 
111  // Pre-defined special status objects.
113  static const Status& OK;
115  static const Status& CANCELLED;
116 
118  StatusCode error_code() const { return code_; }
120  std::string error_message() const { return error_message_; }
122  // Usually it contains a serialized google.rpc.Status proto.
123  std::string error_details() const { return binary_error_details_; }
124 
126  bool ok() const { return code_ == StatusCode::OK; }
127 
128  // Ignores any errors. This method does nothing except potentially suppress
129  // complaints from any tools that are checking that errors are not dropped on
130  // the floor.
131  void IgnoreError() const {}
132 
133  private:
134  StatusCode code_;
135  std::string error_message_;
136  std::string binary_error_details_;
137 };
138 
139 } // namespace grpc
140 
141 #endif // GRPCPP_IMPL_CODEGEN_STATUS_H
grpc::UNAVAILABLE
@ UNAVAILABLE
The service is currently unavailable.
Definition: status_code_enum.h:134
GRPC_STATUS_INTERNAL
@ GRPC_STATUS_INTERNAL
Internal errors.
Definition: status.h:129
GRPC_STATUS_ABORTED
@ GRPC_STATUS_ABORTED
The operation was aborted, typically due to a concurrency issue like sequencer check failures,...
Definition: status.h:104
status.h
GRPC_STATUS_RESOURCE_EXHAUSTED
@ GRPC_STATUS_RESOURCE_EXHAUSTED
Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out ...
Definition: status.h:76
grpc
An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...
Definition: alarm.h:33
GRPC_STATUS_UNAUTHENTICATED
@ GRPC_STATUS_UNAUTHENTICATED
The request does not have valid authentication credentials for the operation.
Definition: status.h:72
config.h
grpc::PERMISSION_DENIED
@ PERMISSION_DENIED
The caller does not have permission to execute the specified operation.
Definition: status_code_enum.h:64
grpc::Status::Status
Status()
Construct an OK instance.
Definition: status.h:38
GRPC_STATUS_UNKNOWN
@ GRPC_STATUS_UNKNOWN
Unknown error.
Definition: status.h:40
GRPC_STATUS_UNIMPLEMENTED
@ GRPC_STATUS_UNIMPLEMENTED
Operation is not implemented or not supported/enabled in this service.
Definition: status.h:124
GRPC_STATUS_PERMISSION_DENIED
@ GRPC_STATUS_PERMISSION_DENIED
The caller does not have permission to execute the specified operation.
Definition: status.h:68
grpc::ALREADY_EXISTS
@ ALREADY_EXISTS
Some entity that we attempted to create (e.g., file or directory) already exists.
Definition: status_code_enum.h:57
grpc::Status::ok
bool ok() const
Is the status OK?
Definition: status.h:126
grpc::DATA_LOSS
@ DATA_LOSS
Unrecoverable data loss or corruption.
Definition: status_code_enum.h:137
grpc::FAILED_PRECONDITION
@ FAILED_PRECONDITION
Operation was rejected because the system is not in a state required for the operation's execution.
Definition: status_code_enum.h:92
status_code_enum.h
GRPC_STATUS_DATA_LOSS
@ GRPC_STATUS_DATA_LOSS
Unrecoverable data loss or corruption.
Definition: status.h:146
grpc::Status
Did it work? If it didn't, why?
Definition: status.h:35
GRPC_STATUS_OUT_OF_RANGE
@ GRPC_STATUS_OUT_OF_RANGE
Operation was attempted past the valid range.
Definition: status.h:121
GRPC_STATUS_INVALID_ARGUMENT
@ GRPC_STATUS_INVALID_ARGUMENT
Client specified an invalid argument.
Definition: status.h:46
grpc::Status::Status
Status(StatusCode code, const std::string &error_message, const std::string &error_details)
Construct an instance with code, error_message and error_details.
Definition: status.h:105
GRPC_STATUS_DEADLINE_EXCEEDED
@ GRPC_STATUS_DEADLINE_EXCEEDED
Deadline expired before operation could complete.
Definition: status.h:53
GRPC_STATUS_UNAVAILABLE
@ GRPC_STATUS_UNAVAILABLE
The service is currently unavailable.
Definition: status.h:143
grpc::OK
@ OK
Not an error; returned on success.
Definition: status_code_enum.h:28
grpc::Status::Status
Status(StatusCode code, const std::string &error_message)
Construct an instance with associated code and error_message.
Definition: status.h:99
GRPC_MUST_USE_RESULT_WHEN_USE_STRICT_WARNING
#define GRPC_MUST_USE_RESULT_WHEN_USE_STRICT_WARNING
Definition: port_platform.h:590
grpc::Status::error_message
std::string error_message() const
Return the instance's error message.
Definition: status.h:120
grpc::StatusCode
StatusCode
Definition: status_code_enum.h:26
grpc::Status::IgnoreError
void IgnoreError() const
Definition: status.h:131
grpc::Status::CANCELLED
static const Status & CANCELLED
A CANCELLED pre-defined instance.
Definition: status.h:115
GRPC_STATUS_NOT_FOUND
@ GRPC_STATUS_NOT_FOUND
Some requested entity (e.g., file or directory) was not found.
Definition: status.h:56
grpc::Status::error_code
StatusCode error_code() const
Return the instance's error code.
Definition: status.h:118
grpc::ABORTED
@ ABORTED
The operation was aborted, typically due to a concurrency issue like sequencer check failures,...
Definition: status_code_enum.h:99
GRPC_STATUS_OK
@ GRPC_STATUS_OK
Not an error; returned on success.
Definition: status.h:30
grpc::DEADLINE_EXCEEDED
@ DEADLINE_EXCEEDED
Deadline expired before operation could complete.
Definition: status_code_enum.h:50
grpc::Status::OK
static const Status & OK
An OK pre-defined instance.
Definition: status.h:113
grpc::UNIMPLEMENTED
@ UNIMPLEMENTED
Operation is not implemented or not supported/enabled in this service.
Definition: status_code_enum.h:117
grpc::NOT_FOUND
@ NOT_FOUND
Some requested entity (e.g., file or directory) was not found.
Definition: status_code_enum.h:53
grpc::CANCELLED
@ CANCELLED
The operation was cancelled (typically by the caller).
Definition: status_code_enum.h:31
port_platform.h
grpc::OUT_OF_RANGE
@ OUT_OF_RANGE
Operation was attempted past the valid range.
Definition: status_code_enum.h:114
grpc::INVALID_ARGUMENT
@ INVALID_ARGUMENT
Client specified an invalid argument.
Definition: status_code_enum.h:43
grpc::UNKNOWN
@ UNKNOWN
Unknown error.
Definition: status_code_enum.h:37
grpc::RESOURCE_EXHAUSTED
@ RESOURCE_EXHAUSTED
Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out ...
Definition: status_code_enum.h:72
grpc::UNAUTHENTICATED
@ UNAUTHENTICATED
The request does not have valid authentication credentials for the operation.
Definition: status_code_enum.h:68
GRPC_STATUS_CANCELLED
@ GRPC_STATUS_CANCELLED
The operation was cancelled (typically by the caller).
Definition: status.h:33
GRPC_STATUS_FAILED_PRECONDITION
@ GRPC_STATUS_FAILED_PRECONDITION
Operation was rejected because the system is not in a state required for the operation's execution.
Definition: status.h:97
grpc::Status::error_details
std::string error_details() const
Return the (binary) error details.
Definition: status.h:123
grpc::INTERNAL
@ INTERNAL
Internal errors.
Definition: status_code_enum.h:121
GRPC_STATUS_ALREADY_EXISTS
@ GRPC_STATUS_ALREADY_EXISTS
Some entity that we attempted to create (e.g., file or directory) already exists.
Definition: status.h:60