|
GRPC C++
1.31.1
|
This header provides an object that reads bytes directly from a grpc::ByteBuffer, via the ZeroCopyInputStream interface. More...
Namespaces | |
| experimental | |
| ClientRpcInfo represents the state of a particular RPC as it appears to an interceptor. | |
| internal | |
| Models a gRPC server. | |
| protobuf | |
| testing | |
Data Structures | |
| class | AsyncGenericService |
| class | AuthContext |
| Class encapsulating the Authentication Information. More... | |
| class | AuthMetadataProcessor |
| Interface allowing custom server-side authorization based on credentials encoded in metadata. More... | |
| class | AuthPropertyIterator |
| class | ByteBuffer |
| A sequence of bytes. More... | |
| class | ChannelInterface |
| Codegen interface for grpc::Channel. More... | |
| class | CoreCodegen |
| Implementation of the core codegen interface. More... | |
| class | CoreCodegenInterface |
| Interface between the codegen library and the minimal subset of core features required by the generated code. More... | |
| class | GenericServerContext |
| class | GrpcLibraryCodegen |
| Classes that require gRPC to be initialized should inherit from this class. More... | |
| class | GrpcLibraryInterface |
| class | HealthCheckServiceInterface |
| The gRPC server uses this interface to expose the health checking service without depending on protobuf. More... | |
| class | HealthCheckServiceServerBuilderOption |
| class | ProtoBufferReader |
| This is a specialization of the protobuf class ZeroCopyInputStream The principle is to get one chunk of data at a time from the proto layer, with options to backup (re-see some bytes) or skip (forward past some bytes) More... | |
| class | ProtoBufferWriter |
| This is a specialization of the protobuf class ZeroCopyOutputStream. More... | |
| class | ResourceQuota |
| ResourceQuota represents a bound on memory and thread usage by the gRPC library. More... | |
| class | SerializationTraits |
| Defines how to serialize and deserialize some type. More... | |
| class | SerializationTraits< ByteBuffer, void > |
| class | ServerBuilder |
| A builder class for the creation and startup of grpc::Server instances. More... | |
| class | ServerBuilderPlugin |
| This interface is meant for internal usage only. More... | |
| class | ServerInterface |
| class | Service |
| Desriptor of an RPC service and its various RPC methods. More... | |
| class | Slice |
| A wrapper around grpc_slice. More... | |
| struct | SslServerCredentialsOptions |
| Options to create ServerCredentials with SSL. More... | |
| class | Status |
| Did it work? If it didn't, why? More... | |
| class | string_ref |
| This class is a non owning reference to a string. More... | |
| class | StubOptions |
| Useful interface for generated stubs. More... | |
| class | TemplatedGenericStub |
| Generic stubs provide a type-unaware interface to call gRPC methods by name. More... | |
| class | TimePoint |
| If you are trying to use CompletionQueue::AsyncNext with a time class that isn't either gpr_timespec or std::chrono::system_clock::time_point, you will most likely be looking at this comment as your compiler will have fired an error below. More... | |
| class | TimePoint< gpr_timespec > |
| class | TimePoint< std::chrono::system_clock::time_point > |
| class | WriteOptions |
| Per-message write options. More... | |
Enumerations | |
| enum | StatusCode { OK = 0, CANCELLED = 1, UNKNOWN = 2, INVALID_ARGUMENT = 3, DEADLINE_EXCEEDED = 4, NOT_FOUND = 5, ALREADY_EXISTS = 6, PERMISSION_DENIED = 7, UNAUTHENTICATED = 16, RESOURCE_EXHAUSTED = 8, FAILED_PRECONDITION = 9, ABORTED = 10, OUT_OF_RANGE = 11, UNIMPLEMENTED = 12, INTERNAL = 13, UNAVAILABLE = 14, DATA_LOSS = 15, DO_NOT_USE = -1 } |
Functions | |
| std::shared_ptr<::grpc_impl::Channel > | CreateChannelInternal (const std::string &host, grpc_channel *c_channel, std::vector< std::unique_ptr< experimental::ClientInterceptorFactoryInterface >> interceptor_creators) |
| std::string | Version () |
| Return gRPC library version. More... | |
| void | EnableDefaultHealthCheckService (bool enable) |
| Enable/disable the default health checking service. More... | |
| bool | DefaultHealthCheckServiceEnabled () |
| Returns whether the default health checking service is enabled. More... | |
| std::unique_ptr< ServerBuilderOption > | MakeChannelArgumentOption (const std::string &name, const std::string &value) |
| std::unique_ptr< ServerBuilderOption > | MakeChannelArgumentOption (const std::string &name, int value) |
| std::shared_ptr< const AuthContext > | CreateAuthContext (grpc_call *call) |
| template<class ProtoBufferWriter , class T > | |
| Status | GenericSerialize (const grpc::protobuf::MessageLite &msg, ByteBuffer *bb, bool *own_buffer) |
| template<class ProtoBufferReader , class T > | |
| Status | GenericDeserialize (ByteBuffer *buffer, grpc::protobuf::MessageLite *msg) |
| grpc::string_ref | StringRefFromSlice (const grpc_slice *slice) |
| std::string | StringFromCopiedSlice (grpc_slice slice) |
| grpc_slice | SliceReferencingString (const std::string &str) |
| grpc_slice | SliceFromCopiedString (const std::string &str) |
| bool | operator== (string_ref x, string_ref y) |
| Comparison operators. More... | |
| bool | operator!= (string_ref x, string_ref y) |
| bool | operator< (string_ref x, string_ref y) |
| bool | operator<= (string_ref x, string_ref y) |
| bool | operator> (string_ref x, string_ref y) |
| bool | operator>= (string_ref x, string_ref y) |
| std::ostream & | operator<< (std::ostream &out, const string_ref &string) |
| void | Timepoint2Timespec (const std::chrono::system_clock::time_point &from, gpr_timespec *to) |
| void | TimepointHR2Timespec (const std::chrono::high_resolution_clock::time_point &from, gpr_timespec *to) |
| std::chrono::system_clock::time_point | Timespec2Timepoint (gpr_timespec t) |
Variables | |
| const char | kHealthCheckServiceInterfaceArg [] |
| CoreCodegenInterface * | g_core_codegen_interface |
| GrpcLibraryInterface * | g_glip |
| Initialized by grpc::GrpcLibraryInitializer from <grpcpp/impl/grpc_library.h> More... | |
| const int | kProtoBufferWriterMaxBufferLength = 1024 * 1024 |
| constexpr long | kMaxAuthTokenLifetimeSecs |
| Constant for maximum auth token lifetime. More... | |
This header provides an object that reads bytes directly from a grpc::ByteBuffer, via the ZeroCopyInputStream interface.
This header provides serialization and deserialization between gRPC messages serialized using protobuf and the C++ objects they represent.
This header provides an object that writes bytes directly into a grpc::ByteBuffer, via the ZeroCopyOutputStream interface.
| typedef ::grpc_impl::Alarm grpc::Alarm |
| typedef std::pair<string_ref, string_ref> grpc::AuthProperty |
| typedef ::grpc_impl::Channel grpc::Channel |
| using grpc::ClientAsyncReader = typedef ::grpc_impl::ClientAsyncReader<R> |
| using grpc::ClientAsyncReaderInterface = typedef ::grpc_impl::ClientAsyncReaderInterface<R> |
| using grpc::ClientAsyncReaderWriter = typedef ::grpc_impl::ClientAsyncReaderWriter<W, R> |
| using grpc::ClientAsyncReaderWriterInterface = typedef ::grpc_impl::ClientAsyncReaderWriterInterface<W, R> |
| using grpc::ClientAsyncResponseReader = typedef grpc_impl::ClientAsyncResponseReader<R> |
| using grpc::ClientAsyncResponseReaderInterface = typedef grpc_impl::ClientAsyncResponseReaderInterface<R> |
| using grpc::ClientAsyncWriter = typedef ::grpc_impl::ClientAsyncWriter<W> |
| using grpc::ClientAsyncWriterInterface = typedef ::grpc_impl::ClientAsyncWriterInterface<W> |
| typedef ::grpc_impl::ClientContext grpc::ClientContext |
| using grpc::ClientReader = typedef ::grpc_impl::ClientReader<R> |
| using grpc::ClientReaderInterface = typedef ::grpc_impl::ClientReaderInterface<R> |
| using grpc::ClientReaderWriter = typedef ::grpc_impl::ClientReaderWriter<W, R> |
| using grpc::ClientReaderWriterInterface = typedef ::grpc_impl::ClientReaderWriterInterface<W, R> |
| using grpc::ClientWriter = typedef ::grpc_impl::ClientWriter<W> |
| using grpc::ClientWriterInterface = typedef ::grpc_impl::ClientWriterInterface<W> |
| typedef ::grpc_impl::ClientAsyncReaderWriter<ByteBuffer, ByteBuffer> grpc::GenericClientAsyncReaderWriter |
| typedef ::grpc_impl::ServerAsyncReaderWriter<ByteBuffer, ByteBuffer> grpc::GenericServerAsyncReaderWriter |
| typedef::grpc_impl::MetadataCredentialsPlugin grpc::MetadataCredentialsPlugin |
| typedef ::grpc_impl::SecureCallCredentials grpc::SecureCallCredentials |
| typedef ::grpc_impl::SecureChannelCredentials grpc::SecureChannelCredentials |
| typedef ::grpc_impl::Server grpc::Server |
| using grpc::ServerAsyncReader = typedef ::grpc_impl::ServerAsyncReader<W, R> |
| using grpc::ServerAsyncReaderInterface = typedef ::grpc_impl::ServerAsyncReaderInterface<W, R> |
| using grpc::ServerAsyncReaderWriter = typedef ::grpc_impl::ServerAsyncReaderWriter<W, R> |
| using grpc::ServerAsyncReaderWriterInterface = typedef ::grpc_impl::ServerAsyncReaderWriterInterface<W, R> |
| using grpc::ServerAsyncResponseWriter = typedef ::grpc_impl::ServerAsyncResponseWriter<W> |
| using grpc::ServerAsyncWriter = typedef ::grpc_impl::ServerAsyncWriter<W> |
| using grpc::ServerAsyncWriterInterface = typedef ::grpc_impl::ServerAsyncWriterInterface<W> |
| typedef ::grpc_impl::ServerContext grpc::ServerContext |
| using grpc::ServerReader = typedef ::grpc_impl::ServerReader<R> |
| using grpc::ServerReaderInterface = typedef ::grpc_impl::ServerReaderInterface<R> |
| using grpc::ServerReaderWriter = typedef ::grpc_impl::ServerReaderWriter<W, R> |
| using grpc::ServerReaderWriterInterface = typedef ::grpc_impl::ServerReaderWriterInterface<W, R> |
| using grpc::ServerSplitStreamer = typedef ::grpc_impl::ServerSplitStreamer<RequestType, ResponseType> |
| using grpc::ServerUnaryStreamer = typedef ::grpc_impl::ServerUnaryStreamer<RequestType, ResponseType> |
| using grpc::ServerWriter = typedef ::grpc_impl::ServerWriter<W> |
| using grpc::ServerWriterInterface = typedef ::grpc_impl::ServerWriterInterface<W> |
| enum grpc::StatusCode |
| Enumerator | |
|---|---|
| OK | Not an error; returned on success. |
| CANCELLED | The operation was cancelled (typically by the caller). |
| UNKNOWN | Unknown error. An example of where this error may be returned is if a Status value received from another address space belongs to an error-space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. |
| INVALID_ARGUMENT | Client specified an invalid argument. Note that this differs from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). |
| DEADLINE_EXCEEDED | Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. |
| NOT_FOUND | Some requested entity (e.g., file or directory) was not found. |
| ALREADY_EXISTS | Some entity that we attempted to create (e.g., file or directory) already exists. |
| PERMISSION_DENIED | The caller does not have permission to execute the specified operation. PERMISSION_DENIED must not be used for rejections caused by exhausting some resource (use RESOURCE_EXHAUSTED instead for those errors). PERMISSION_DENIED must not be used if the caller can not be identified (use UNAUTHENTICATED instead for those errors). |
| UNAUTHENTICATED | The request does not have valid authentication credentials for the operation. |
| RESOURCE_EXHAUSTED | Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. |
| FAILED_PRECONDITION | Operation was rejected because the system is not in a state required for the operation's execution. For example, directory to be deleted may be non-empty, an rmdir operation is applied to a non-directory, etc. A litmus test that may help a service implementor in deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE: (a) Use UNAVAILABLE if the client can retry just the failing call. (b) Use ABORTED if the client should retry at a higher-level (e.g., restarting a read-modify-write sequence). (c) Use FAILED_PRECONDITION if the client should not retry until the system state has been explicitly fixed. E.g., if an "rmdir" fails because the directory is non-empty, FAILED_PRECONDITION should be returned since the client should not retry unless they have first fixed up the directory by deleting files from it. (d) Use FAILED_PRECONDITION if the client performs conditional REST Get/Update/Delete on a resource and the resource on the server does not match the condition. E.g., conflicting read-modify-write on the same resource. |
| ABORTED | The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc. See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE. |
| OUT_OF_RANGE | Operation was attempted past the valid range. E.g., seeking or reading past end of file. Unlike INVALID_ARGUMENT, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate INVALID_ARGUMENT if asked to read at an offset that is not in the range [0,2^32-1], but it will generate OUT_OF_RANGE if asked to read from an offset past the current file size. There is a fair bit of overlap between FAILED_PRECONDITION and OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific error) when it applies so that callers who are iterating through a space can easily look for an OUT_OF_RANGE error to detect when they are done. |
| UNIMPLEMENTED | Operation is not implemented or not supported/enabled in this service. |
| INTERNAL | Internal errors. Means some invariants expected by underlying System has been broken. If you see one of these errors, Something is very broken. |
| UNAVAILABLE | The service is currently unavailable. This is a most likely a transient condition and may be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations.
See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE. |
| DATA_LOSS | Unrecoverable data loss or corruption. |
| DO_NOT_USE | Force users to include a default branch: |
| std::shared_ptr<const AuthContext> grpc::CreateAuthContext | ( | grpc_call * | call | ) |
| std::shared_ptr<::grpc_impl::Channel> grpc::CreateChannelInternal | ( | const std::string & | host, |
| grpc_channel * | c_channel, | ||
| std::vector< std::unique_ptr< experimental::ClientInterceptorFactoryInterface >> | interceptor_creators | ||
| ) |
| bool grpc::DefaultHealthCheckServiceEnabled | ( | ) |
Returns whether the default health checking service is enabled.
NOT thread safe.
| void grpc::EnableDefaultHealthCheckService | ( | bool | enable | ) |
Enable/disable the default health checking service.
This applies to all C++ servers created afterwards. For each server, user can override the default with a HealthCheckServiceServerBuilderOption. NOT thread safe.
| Status grpc::GenericDeserialize | ( | ByteBuffer * | buffer, |
| grpc::protobuf::MessageLite * | msg | ||
| ) |
| Status grpc::GenericSerialize | ( | const grpc::protobuf::MessageLite & | msg, |
| ByteBuffer * | bb, | ||
| bool * | own_buffer | ||
| ) |
| std::unique_ptr<ServerBuilderOption> grpc::MakeChannelArgumentOption | ( | const std::string & | name, |
| const std::string & | value | ||
| ) |
| std::unique_ptr<ServerBuilderOption> grpc::MakeChannelArgumentOption | ( | const std::string & | name, |
| int | value | ||
| ) |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Comparison operators.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
| void grpc::Timepoint2Timespec | ( | const std::chrono::system_clock::time_point & | from, |
| gpr_timespec * | to | ||
| ) |
| void grpc::TimepointHR2Timespec | ( | const std::chrono::high_resolution_clock::time_point & | from, |
| gpr_timespec * | to | ||
| ) |
| std::chrono::system_clock::time_point grpc::Timespec2Timepoint | ( | gpr_timespec | t | ) |
| std::string grpc::Version | ( | ) |
Return gRPC library version.
| CoreCodegenInterface * grpc::g_core_codegen_interface |
| GrpcLibraryInterface* grpc::g_glip |
Initialized by grpc::GrpcLibraryInitializer from <grpcpp/impl/grpc_library.h>
| const char grpc::kHealthCheckServiceInterfaceArg[] |
|
constexpr |
Constant for maximum auth token lifetime.
| const int grpc::kProtoBufferWriterMaxBufferLength = 1024 * 1024 |
1.8.17