Immutable user configurable options for a gRPC call.
More...
#import <GRPCCallOptions.h>
Immutable user configurable options for a gRPC call.
Caller can obtain a mutable copy of type GRPCMutableCallOptions by calling [option mutableCopy]
◆ hasChannelOptionsEqualTo:
Return if the channel options are equal to another object.
◆ additionalChannelArgs
Specify channel args to be used for this call.
For a list of channel args available, see grpc/grpc_types.h
◆ authTokenProvider
The interface to get the OAuth2 access token string.
gRPC will attempt to acquire token when initiating the call. This parameter should not be used simultaneously with oauth2AccessToken.
◆ channelID
Channel id allows control of channel caching within a channelPoolDomain.
A call with a unique channelID will create a new channel (connection) instead of reusing an existing one. Multiple calls in the same channelPoolDomain using identical channelID are allowed to share connection if other channel options are also the same.
◆ channelOptionsHash
| - (NSUInteger) channelOptionsHash |
|
readnonatomicassign |
Hash for channel options.
◆ channelPoolDomain
| - (NSString*) channelPoolDomain |
|
readnonatomiccopy |
A string that specify the domain where channel is being cached.
Channels with different domains will not get cached to the same connection.
◆ compressionAlgorithm
| - (GRPCCompressionAlgorithm) compressionAlgorithm |
|
readnonatomicassign |
◆ connectInitialBackoff
| - (NSTimeInterval) connectInitialBackoff |
|
readnonatomicassign |
◆ connectMaxBackoff
| - (NSTimeInterval) connectMaxBackoff |
|
readnonatomicassign |
◆ connectMinTimeout
| - (NSTimeInterval) connectMinTimeout |
|
readnonatomicassign |
◆ flowControlEnabled
| - (BOOL) flowControlEnabled |
|
readnonatomicassign |
Enable flow control of a gRPC call.
The option is default to NO. If set to YES, writeData: method should only be called at most once before a didWriteData callback is issued, and receiveNextMessage: must be called each time before gRPC call issues a didReceiveMessage callback.
◆ hostNameOverride
| - (NSString*) hostNameOverride |
|
readnonatomiccopy |
Override the hostname during the TLS hostname validation process.
◆ initialMetadata
Initial metadata key-value pairs that should be included in the request.
Dictionary key is of type NSString, value should be either NSString or NSData containing binary bytes data.
◆ interceptorFactories
An array of interceptor factories.
When a call starts, interceptors are created by these factories and chained together with the same order as the factories in this array. This parameter should not be modified by any interceptor and will not take effect if done so.
◆ keepaliveInterval
| - (NSTimeInterval) keepaliveInterval |
|
readnonatomicassign |
◆ keepaliveTimeout
| - (NSTimeInterval) keepaliveTimeout |
|
readnonatomicassign |
◆ maxRetryInterval
| - (NSTimeInterval) maxRetryInterval |
|
readnonatomicassign |
Maximum interval in seconds between two consecutive retries.
Internal-only property used for GTMSessionFetcher transport retry policy.
◆ minRetryInterval
| - (NSTimeInterval) minRetryInterval |
|
readnonatomicassign |
Minimum interval in seconds between two consecutive retries.
Internal-only property used for GTMSessionFetcher transport retry policy.
◆ oauth2AccessToken
| - (NSString*) oauth2AccessToken |
|
readnonatomiccopy |
The OAuth2 access token string.
The string is prefixed with "Bearer " then used as value of the request's "authorization" header field. This parameter should not be used simultaneously with authTokenProvider.
◆ PEMCertificateChain
| - (NSString*) PEMCertificateChain |
|
readnonatomiccopy |
PEM format certificate chain for client authentication, if required by the server.
◆ PEMPrivateKey
| - (NSString*) PEMPrivateKey |
|
readnonatomiccopy |
PEM format private key for client authentication, if required by the server.
◆ PEMRootCertificates
| - (NSString*) PEMRootCertificates |
|
readnonatomiccopy |
PEM format root certifications that is trusted.
If set to nil, gRPC uses a list of default root certificates.
◆ responseSizeLimit
| - (NSUInteger) responseSizeLimit |
|
readnonatomicassign |
The size limit for the response received from server.
If it is exceeded, an error with status code GRPCErrorCodeResourceExhausted is returned.
◆ retryEnabled
◆ retryFactor
Multiplier used to increase the interval between retries.
Internal-only property used for GTMSessionFetcher transport retry policy.
◆ serverAuthority
| - (NSString*) serverAuthority |
|
readnonatomiccopy |
The authority for the RPC.
If nil, the default authority will be used.
Note: This property does not have effect on Cronet transport and will be ignored. Note: This property cannot be used to validate a self-signed server certificate. It control the :authority header field of the call and performs an extra check that server's certificate matches the :authority header.
◆ timeout
| - (NSTimeInterval) timeout |
|
readnonatomicassign |
The timeout for the RPC call in seconds.
If set to 0, the call will not timeout. If set to positive, the gRPC call returns with status GRPCErrorCodeDeadlineExceeded if it is not completed within timeout seconds. A negative value is not allowed.
◆ transport
The transport to be used for this call.
Users may choose a native transport identifier defined in GRPCTransport or provided by a non-native transport implementation. If the option is left to be NULL, gRPC will use its default transport.
This is currently an experimental option.
◆ transportType
| - (GRPCTransportType) transportType |
|
readnonatomicassign |
Deprecated: this option is deprecated.
Please use the property transport instead.
Select the transport type to be used for this call.
◆ userAgentPrefix
| - (NSString*) userAgentPrefix |
|
readnonatomiccopy |
Custom string that is prefixed to a request's user-agent header field before gRPC's internal user-agent string.
◆ userAgentSuffix
| - (NSString*) userAgentSuffix |
|
readnonatomiccopy |
Custom string that is suffixed to a request's user-agent header field after gRPC's internal user-agent string.
The documentation for this class was generated from the following file:
