public struct CallOptions
Options for calls made by client.
Namespace
Grpc.CoreAssembly
Grpc.Core.Api.dll
Constructors
CallOptions(Metadata, Nullable<DateTime>, CancellationToken, WriteOptions, ContextPropagationToken, CallCredentials)
public CallOptions(Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null, WriteOptions writeOptions = null, ContextPropagationToken propagationToken = null, CallCredentials credentials = null)
Creates a new instance of CallOptions
struct.
Type | Name | Description |
---|---|---|
Metadata | headers | Headers to be sent with the call. |
Nullable<DateTime> | deadline | Deadline for the call to finish. null means no deadline. |
CancellationToken | cancellationToken | Can be used to request cancellation of the call. |
WriteOptions | writeOptions | Write options that will be used for this call. |
ContextPropagationToken | propagationToken | Context propagation token obtained from ServerCallContext. |
CallCredentials | credentials | Credentials to use for this call. |
Properties
CancellationToken
public CancellationToken CancellationToken { get; }
Token that can be used for cancelling the call on the client side.
Cancelling the token will request cancellation
of the remote call. Best effort will be made to deliver the cancellation
notification to the server and interaction of the call with the server side
will be terminated. Unless the call finishes before the cancellation could
happen (there is an inherent race),
the call will finish with StatusCode.Cancelled
status.
Type | Description |
---|---|
CancellationToken |
Credentials
public CallCredentials Credentials { get; }
Credentials to use for this call.
Type | Description |
---|---|
CallCredentials |
Deadline
public DateTime? Deadline { get; }
Call deadline.
Type | Description |
---|---|
Nullable<DateTime> |
Headers
public Metadata Headers { get; }
Headers to send at the beginning of the call.
Type | Description |
---|---|
Metadata |
IsWaitForReady
public bool IsWaitForReady { get; }
If true
and channel is in ChannelState.TransientFailure
, the call will attempt waiting for the channel to recover
instead of failing immediately (which is the default "FailFast" semantics).
Note: experimental API that can change or be removed without any prior notice.
Type | Description |
---|---|
Boolean |
PropagationToken
public ContextPropagationToken PropagationToken { get; }
Token for propagating parent call context.
Type | Description |
---|---|
ContextPropagationToken |
WriteOptions
public WriteOptions WriteOptions { get; }
Write options that will be used for this call.
Type | Description |
---|---|
WriteOptions |
Methods
WithCancellationToken(CancellationToken)
public CallOptions WithCancellationToken(CancellationToken cancellationToken)
Returns new instance of CallOptions with
CancellationToken
set to the value provided. Values of all other fields are preserved.
Type | Name | Description |
---|---|---|
CancellationToken | cancellationToken | The cancellation token. |
Type | Description |
---|---|
CallOptions |
WithCredentials(CallCredentials)
public CallOptions WithCredentials(CallCredentials credentials)
Returns new instance of CallOptions with
Credentials
set to the value provided. Values of all other fields are preserved.
Type | Name | Description |
---|---|---|
CallCredentials | credentials | The call credentials. |
Type | Description |
---|---|
CallOptions |
WithDeadline(DateTime)
public CallOptions WithDeadline(DateTime deadline)
Returns new instance of CallOptions with
Deadline
set to the value provided. Values of all other fields are preserved.
Type | Name | Description |
---|---|---|
DateTime | deadline | The deadline. |
Type | Description |
---|---|
CallOptions |
WithHeaders(Metadata)
public CallOptions WithHeaders(Metadata headers)
Returns new instance of CallOptions with
Headers
set to the value provided. Values of all other fields are preserved.
Type | Name | Description |
---|---|---|
Metadata | headers | The headers. |
Type | Description |
---|---|
CallOptions |
WithPropagationToken(ContextPropagationToken)
public CallOptions WithPropagationToken(ContextPropagationToken propagationToken)
Returns new instance of CallOptions with
PropagationToken
set to the value provided. Values of all other fields are preserved.
Type | Name | Description |
---|---|---|
ContextPropagationToken | propagationToken | The context propagation token. |
Type | Description |
---|---|
CallOptions |
WithWaitForReady(Boolean)
public CallOptions WithWaitForReady(bool waitForReady = true)
Returns new instance of CallOptions with "WaitForReady" semantics enabled/disabled. IsWaitForReady. Note: experimental API that can change or be removed without any prior notice.
Type | Name | Description |
---|---|---|
Boolean | waitForReady |
Type | Description |
---|---|
CallOptions |
WithWriteOptions(WriteOptions)
public CallOptions WithWriteOptions(WriteOptions writeOptions)
Returns new instance of CallOptions with
WriteOptions
set to the value provided. Values of all other fields are preserved.
Type | Name | Description |
---|---|---|
WriteOptions | writeOptions | The write options. |
Type | Description |
---|---|
CallOptions |