#import <Foundation/Foundation.h>
Go to the source code of this file.
Classes | |
| protocol | <GRPCAuthorizationProtocol> |
Typedefs | |
| typedef GRPCCompressionAlgorithm | GRPCCompressAlgorithm |
| typedef NSDictionary< NSString *, id > | GRPCMetadataDictionary |
| typedef char *_Nonnull | GRPCTransportID |
Functions | |
| typedef | NS_ENUM (NSUInteger, GRPCCallSafety) |
| typedef | NS_ENUM (NSUInteger, GRPCCompressionAlgorithm) |
| typedef | NS_ENUM (NSUInteger, GRPCErrorCode) |
| typedef | NS_ENUM (NSUInteger, GRPCTransportType) |
Variables | |
| NSString *const _Nonnull | kGRPCErrorDomain |
| NSString *const _Nonnull | kGRPCHeadersKey |
| NSString *const _Nonnull | kGRPCTrailersKey |
Typedef Documentation
◆ GRPCCompressAlgorithm
| typedef GRPCCompressionAlgorithm GRPCCompressAlgorithm |
GRPCCompressAlgorithm is deprecated.
Definition at line 147 of file GRPCTypes.h.
◆ GRPCMetadataDictionary
| typedef NSDictionary<NSString*, id> GRPCMetadataDictionary |
gRPC metadata dictionary typedef
Definition at line 190 of file GRPCTypes.h.
◆ GRPCTransportID
| typedef char* _Nonnull GRPCTransportID |
The id of a transport implementation.
Definition at line 174 of file GRPCTypes.h.
Function Documentation
◆ NS_ENUM() [1/4]
| typedef NS_ENUM | ( | NSUInteger | , |
| GRPCCallSafety | |||
| ) |
Safety remark of a gRPC method as defined in RFC 2616 Section 9.1
Signal that there is no guarantees on how the call affects the server state.
Definition at line 128 of file GRPCTypes.h.
◆ NS_ENUM() [2/4]
| typedef NS_ENUM | ( | NSUInteger | , |
| GRPCCompressionAlgorithm | |||
| ) |
Compression algorithm to be used by a gRPC call.
This enumeration and corresponding call option GRPCCallOptions.transportType are deprecated by the call option GRPCCallOptions.transport.
Definition at line 142 of file GRPCTypes.h.
◆ NS_ENUM() [3/4]
| typedef NS_ENUM | ( | NSUInteger | , |
| GRPCErrorCode | |||
| ) |
gRPC error codes. Note that a few of these are never produced by the gRPC libraries, but are of general utility for server applications to produce.
The operation was cancelled (typically by the caller).
Unknown error. Errors raised by APIs that do not return enough error information may be converted to this error.
The 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 server (e.g., a malformed file name).
Deadline expired before operation could complete. For operations that change the state of the server, this error may be returned even if the operation has completed successfully. For example, a successful response from the server could have been delayed long enough for the deadline to expire.
Some requested entity (e.g., file or directory) was not found.
Some entity that we attempted to create (e.g., file or directory) already exists.
The caller does not have permission to execute the specified operation. PERMISSION_DENIED isn't used for rejections caused by exhausting some resource (RESOURCE_EXHAUSTED is used instead for those errors). PERMISSION_DENIED doesn't indicate a failure to identify the caller (UNAUTHENTICATED is used instead for those errors).
The request does not have valid authentication credentials for the operation (e.g. the caller's identity can't be verified).
Some resource has been exhausted, perhaps a per-user quota.
The RPC was rejected because the server is not in a state required for the procedure's execution. For example, a directory to be deleted may be non-empty, etc. The client should not retry until the server state has been explicitly fixed (e.g. by performing another RPC). The details depend on the service being called, and should be found in the NSError's userInfo.
The RPC was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc. The client should retry at a higher-level (e.g., restarting a read- modify-write sequence).
The RPC was attempted past the valid range. E.g., enumerating past the end of a list. Unlike INVALID_ARGUMENT, this error indicates a problem that may be fixed if the system state changes. For example, an RPC to get elements of a list will generate INVALID_ARGUMENT if asked to return the element at a negative index, but it will generate OUT_OF_RANGE if asked to return the element at an index past the current size of the list.
The procedure is not implemented or not supported/enabled in this server.
Internal error. Means some invariant expected by the server application or the gRPC library has been broken.
The server is currently unavailable. This is 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.
Unrecoverable data loss or corruption.
Definition at line 26 of file GRPCTypes.h.
◆ NS_ENUM() [4/4]
| typedef NS_ENUM | ( | NSUInteger | , |
| GRPCTransportType | |||
| ) |
The transport to be used by a gRPC call
gRPC internal HTTP/2 stack with BoringSSL
Cronet stack
Insecure channel. FOR TEST ONLY!
Definition at line 153 of file GRPCTypes.h.
Variable Documentation
◆ kGRPCErrorDomain
| NSString* const _Nonnull kGRPCErrorDomain |
Domain of NSError objects produced by gRPC.
◆ kGRPCHeadersKey
| NSString* const _Nonnull kGRPCHeadersKey |
Keys used in |NSError|'s |userInfo| dictionary to store the response headers and trailers sent by the server.
◆ kGRPCTrailersKey
| NSString* const _Nonnull kGRPCTrailersKey |