• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_CORE_LIB_TRANSPORT_ERROR_UTILS_H
20 #define GRPC_CORE_LIB_TRANSPORT_ERROR_UTILS_H
21 
22 #include <grpc/support/port_platform.h>
23 
24 #include "absl/status/status.h"
25 
26 #include "src/core/lib/iomgr/error.h"
27 #include "src/core/lib/iomgr/exec_ctx.h"
28 #include "src/core/lib/transport/http2_errors.h"
29 
30 /// A utility function to get the status code and message to be returned
31 /// to the application.  If not set in the top-level message, looks
32 /// through child errors until it finds the first one with these attributes.
33 /// All attributes are pulled from the same child error. error_string will
34 /// be populated with the entire error string. If any of the attributes (code,
35 /// msg, http_status, error_string) are unneeded, they can be passed as
36 /// NULL.
37 void grpc_error_get_status(grpc_error* error, grpc_millis deadline,
38                            grpc_status_code* code, grpc_slice* slice,
39                            grpc_http2_error_code* http_error,
40                            const char** error_string);
41 
42 /// Utility Function to convert a grpc_error * \a error to an absl::Status.
43 /// Does NOT consume a ref to grpc_error.
44 absl::Status grpc_error_to_absl_status(grpc_error* error);
45 
46 /// A utility function to check whether there is a clear status code that
47 /// doesn't need to be guessed in \a error. This means that \a error or some
48 /// child has GRPC_ERROR_INT_GRPC_STATUS set, or that it is GRPC_ERROR_NONE or
49 /// GRPC_ERROR_CANCELLED
50 bool grpc_error_has_clear_grpc_status(grpc_error* error);
51 
52 #endif /* GRPC_CORE_LIB_TRANSPORT_ERROR_UTILS_H */
53