#import <GRPCCallOptions.h>
Additional Inherited Members | |
 Instance Methods inherited from GRPCCallOptions | |
| (BOOL) | - hasChannelOptionsEqualTo: |
Detailed Description
Mutable user configurable options for a gRPC call. Caller can obtain an immutable copy of type GRPCCallOptions by calling [option copy]
Definition at line 232 of file GRPCCallOptions.h.
Property Documentation
◆ additionalChannelArgs
|
readwritenonatomiccopy |
Specify channel args to be used for this call. For a list of channel args available, see grpc/grpc_types.h
Definition at line 367 of file GRPCCallOptions.h.
◆ authTokenProvider
|
readwritenonatomicassign |
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.
Definition at line 287 of file GRPCCallOptions.h.
◆ channelID
|
readwritenonatomicassign |
Channel id allows a call to force creating a new channel (connection) rather than using a cached channel. Calls using distinct channelID's will not get cached to the same channel.
Definition at line 422 of file GRPCCallOptions.h.
◆ channelPoolDomain
|
readwritenonatomiccopy |
A string that specify the domain where channel is being cached. Channels with different domains will not get cached to the same channel. For example, a gRPC example app may use the channel pool domain 'io.grpc.example' so that its calls do not reuse the channel created by other modules in the same process.
Definition at line 416 of file GRPCCallOptions.h.
◆ compressionAlgorithm
|
readwritenonatomicassign |
The compression algorithm to be used by the gRPC call. For more details refer to https://github.com/grpc/grpc/blob/master/doc/compression.md
Definition at line 320 of file GRPCCallOptions.h.
◆ connectInitialBackoff
|
readwritenonatomicassign |
Definition at line 360 of file GRPCCallOptions.h.
◆ connectMaxBackoff
|
readwritenonatomicassign |
Definition at line 361 of file GRPCCallOptions.h.
◆ connectMinTimeout
|
readwritenonatomicassign |
Definition at line 359 of file GRPCCallOptions.h.
◆ flowControlEnabled
|
readwritenonatomicassign |
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 can issue a didReceiveMessage callback.
If writeData: method is called more than once before issuance of a didWriteData callback, gRPC will continue to queue the message and write them to gRPC core in order. However, the user assumes their own responsibility of flow control by keeping tracking of the pending writes in the call.
Definition at line 264 of file GRPCCallOptions.h.
◆ hostNameOverride
|
readwritenonatomiccopy |
Override the hostname during the TLS hostname validation process.
Definition at line 408 of file GRPCCallOptions.h.
◆ initialMetadata
|
readwritenonatomiccopy |
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.
Definition at line 294 of file GRPCCallOptions.h.
◆ interceptorFactories
|
readwritenonatomiccopy |
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.
Definition at line 272 of file GRPCCallOptions.h.
◆ keepaliveInterval
|
readwritenonatomicassign |
Definition at line 352 of file GRPCCallOptions.h.
◆ keepaliveTimeout
|
readwritenonatomicassign |
Definition at line 353 of file GRPCCallOptions.h.
◆ logContext
|
readwriteatomicassignimplementation |
Parameter used for internal logging.
Definition at line 37 of file GRPCCallOptions+Internal.h.
◆ maxRetryInterval
|
readwritenonatomicassign |
Maximum interval in seconds between two consecutive retries. Pass 0 to use default. Internal-only property used for GTMSessionFetcher transport retry policy.
Definition at line 333 of file GRPCCallOptions.h.
◆ minRetryInterval
|
readwritenonatomicassign |
Minimum interval in seconds between two consecutive retries. Pass 0 to use default. Internal-only property used for GTMSessionFetcher transport retry policy.
Definition at line 339 of file GRPCCallOptions.h.
◆ oauth2AccessToken
|
readwritenonatomiccopy |
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.
Definition at line 281 of file GRPCCallOptions.h.
◆ PEMCertificateChain
|
readwritenonatomiccopy |
PEM format certificate chain for client authentication, if required by the server.
Definition at line 385 of file GRPCCallOptions.h.
◆ PEMPrivateKey
|
readwritenonatomiccopy |
PEM format private key for client authentication, if required by the server.
Definition at line 380 of file GRPCCallOptions.h.
◆ PEMRootCertificates
|
readwritenonatomiccopy |
PEM format root certifications that is trusted. If set to nil, gRPC uses a list of default root certificates.
Definition at line 375 of file GRPCCallOptions.h.
◆ responseSizeLimit
|
readwritenonatomicassign |
The size limit for the response received from server. If it is exceeded, an error with status code GRPCErrorCodeResourceExhausted is returned.
Definition at line 314 of file GRPCCallOptions.h.
◆ retryEnabled
|
readwritenonatomicassign |
Enable/Disable gRPC call's retry feature. The default is enabled. For details of this feature refer to https://github.com/grpc/proposal/blob/master/A6-client-retries.md
Definition at line 327 of file GRPCCallOptions.h.
◆ retryFactor
|
readwritenonatomicassign |
Multiplier used to increase the interval between retries. Pass 0 to use default. Internal-only property used for GTMSessionFetcher transport retry policy.
Definition at line 345 of file GRPCCallOptions.h.
◆ serverAuthority
|
readwritenonatomiccopy |
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.
Definition at line 243 of file GRPCCallOptions.h.
◆ timeout
|
readwritenonatomicassign |
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. Negative value is invalid; setting the parameter to negative value will reset the parameter to 0.
Definition at line 251 of file GRPCCallOptions.h.
◆ transport
|
readwritenonatomicassign |
The transport to be used for this call. Users may choose a native transport identifier defined in GRPCTransport or provided by a non-native ttransport implementation. If the option is left to be NULL, gRPC will use its default transport.
An interceptor must not change the value of this option.
Definition at line 403 of file GRPCCallOptions.h.
◆ transportType
|
readwritenonatomicassign |
Deprecated: this option is deprecated. Please use the property transport instead.
Select the transport type to be used for this call.
Definition at line 393 of file GRPCCallOptions.h.
◆ userAgentPrefix
|
readwritenonatomiccopy |
Custom string that is prefixed to a request's user-agent header field before gRPC's internal user-agent string.
Definition at line 302 of file GRPCCallOptions.h.
◆ userAgentSuffix
|
readwritenonatomiccopy |
Custom string that is suffixed to a request's user-agent header field after gRPC's internal user-agent string.
Definition at line 308 of file GRPCCallOptions.h.
The documentation for this class was generated from the following file: