legacy-libs/grpc/deps/grpc/src/core/lib/transport/error_utils.h

   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 "src/core/lib/iomgr/error.h"
  25 #include "src/core/lib/iomgr/exec_ctx.h"
  26 #include "src/core/lib/transport/http2_errors.h"
  27
  28 /// A utility function to get the status code and message to be returned
  29 /// to the application.  If not set in the top-level message, looks
  30 /// through child errors until it finds the first one with these attributes.
  31 /// All attributes are pulled from the same child error. error_string will
  32 /// be populated with the entire error string. If any of the attributes (code,
  33 /// msg, http_status, error_string) are unneeded, they can be passed as
  34 /// NULL.
  35 void grpc_error_get_status(grpc_error* error, grpc_millis deadline,
  36                            grpc_status_code* code, grpc_slice* slice,
  37                            grpc_http2_error_code* http_status,
  38                            const char** error_string);
  39
  40 /// A utility function to check whether there is a clear status code that
  41 /// doesn't need to be guessed in \a error. This means that \a error or some
  42 /// child has GRPC_ERROR_INT_GRPC_STATUS set, or that it is GRPC_ERROR_NONE or
  43 /// GRPC_ERROR_CANCELLED
  44 bool grpc_error_has_clear_grpc_status(grpc_error* error);
  45
  46 #endif /* GRPC_CORE_LIB_TRANSPORT_ERROR_UTILS_H */