status_helper.h

Go to the documentation of this file.

//
//
// Copyright 2021 the gRPC authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
//
 
#ifndef GRPC_CORE_LIB_GPRPP_STATUS_HELPER_H
#define GRPC_CORE_LIB_GPRPP_STATUS_HELPER_H
 
#include <grpc/support/port_platform.h>
 
#include <stdint.h>
 
#include <string>
#include <vector>
 
#include "absl/status/status.h"
#include "absl/strings/string_view.h"
#include "absl/time/time.h"
#include "absl/types/optional.h"
 
#include "src/core/lib/gprpp/debug_location.h"
 
extern "C" {
struct google_rpc_Status;
struct upb_Arena;
}
 
namespace grpc_core {
 
// TODO(veblush): Use camel-case names once migration to absl::Status is done.
enum class StatusIntProperty {
  kErrorNo,
  kFileLine,
  kStreamId,
  // TODO(veblush): Remove this after grpc_error is replaced with absl::Status
  kRpcStatus,
  kOffset,
  kIndex,
  kSize,
  kHttp2Error,
  kTsiCode,
  kWsaError,
  kFd,
  kHttpStatus,
  kOccurredDuringWrite,
  ChannelConnectivityState,
  kLbPolicyDrop,
};
 
// TODO(veblush): Use camel-case names once migration to absl::Status is done.
enum class StatusStrProperty {
  kDescription,
  kFile,
  kOsError,
  kSyscall,
  kTargetAddress,
  kGrpcMessage,
  kRawBytes,
  kTsiError,
  kFilename,
  kKey,
  kValue,
};
 
enum class StatusTimeProperty {
  kCreated,
};
 
absl::Status StatusCreate(
    absl::StatusCode code, absl::string_view msg, const DebugLocation& location,
    std::vector<absl::Status> children) GRPC_MUST_USE_RESULT;
 
void StatusSetInt(absl::Status* status, StatusIntProperty key, intptr_t value);
 
absl::optional<intptr_t> StatusGetInt(
    const absl::Status& status, StatusIntProperty key) GRPC_MUST_USE_RESULT;
 
void StatusSetStr(absl::Status* status, StatusStrProperty key,
                  absl::string_view value);
 
absl::optional<std::string> StatusGetStr(
    const absl::Status& status, StatusStrProperty key) GRPC_MUST_USE_RESULT;
 
void StatusSetTime(absl::Status* status, StatusTimeProperty key,
                   absl::Time time);
 
absl::optional<absl::Time> StatusGetTime(
    const absl::Status& status, StatusTimeProperty key) GRPC_MUST_USE_RESULT;
 
void StatusAddChild(absl::Status* status, absl::Status child);
 
std::vector<absl::Status> StatusGetChildren(absl::Status status)
    GRPC_MUST_USE_RESULT;
 
std::string StatusToString(const absl::Status& status) GRPC_MUST_USE_RESULT;
 
namespace internal {
 
google_rpc_Status* StatusToProto(const absl::Status& status,
                                 upb_Arena* arena) GRPC_MUST_USE_RESULT;
 
absl::Status StatusFromProto(google_rpc_Status* msg) GRPC_MUST_USE_RESULT;
 
uintptr_t StatusAllocHeapPtr(absl::Status s);
 
void StatusFreeHeapPtr(uintptr_t ptr);
 
absl::Status StatusGetFromHeapPtr(uintptr_t ptr);
 
absl::Status StatusMoveFromHeapPtr(uintptr_t ptr);
 
}  // namespace internal
 
}  // namespace grpc_core
 
#endif  // GRPC_CORE_LIB_GPRPP_STATUS_HELPER_H