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 GRPC_SRC_CORE_LIB_TRANSPORT_ERROR_UTILS_H 20 #define GRPC_SRC_CORE_LIB_TRANSPORT_ERROR_UTILS_H 21 22 #include <grpc/status.h> 23 #include <grpc/support/port_platform.h> 24 25 #include <string> 26 27 #include "absl/status/status.h" 28 #include "src/core/lib/iomgr/error.h" 29 #include "src/core/lib/transport/http2_errors.h" 30 #include "src/core/util/time.h" 31 32 /// A utility function to get the status code and message to be returned 33 /// to the application. If not set in the top-level message, looks 34 /// through child errors until it finds the first one with these attributes. 35 /// All attributes are pulled from the same child error. error_string will 36 /// be populated with the entire error string. If any of the attributes (code, 37 /// msg, http_status, error_string) are unneeded, they can be passed as 38 /// NULL. 39 void grpc_error_get_status(grpc_error_handle error, 40 grpc_core::Timestamp deadline, 41 grpc_status_code* code, std::string* message, 42 grpc_http2_error_code* http_error, 43 const char** error_string); 44 45 /// Utility Function to convert a grpc_error_handle \a error to an 46 /// absl::Status. Does NOT consume a ref to grpc_error. 47 absl::Status grpc_error_to_absl_status(grpc_error_handle error); 48 49 /// Utility function to convert an absl::Status \a status to grpc_error. Note 50 /// that this method does not return "special case" errors such as 51 /// absl::CancelledError(), with the exception of absl::OkStatus() returned for 52 /// \a absl::OkStatus(). 53 grpc_error_handle absl_status_to_grpc_error(absl::Status status); 54 55 /// A utility function to check whether there is a clear status code that 56 /// doesn't need to be guessed in \a error. This means that \a error or some 57 /// child has grpc_core::StatusIntProperty::kRpcStatus set, or that it is 58 /// absl::OkStatus() or absl::CancelledError() 59 bool grpc_error_has_clear_grpc_status(grpc_error_handle error); 60 61 #endif // GRPC_SRC_CORE_LIB_TRANSPORT_ERROR_UTILS_H 62