Class AsyncUnaryCall<TResponse> (2.66.0)

public sealed class AsyncUnaryCall<TResponse> : IDisposable

Return type for single request - single response call.

Inheritance

object > AsyncUnaryCall<TResponse>

Implements

IDisposable

Namespace

Grpc.Core

Assembly

Grpc.Core.Api.dll

Type Parameter

Name Description
TResponse

Response message type for this call.

Constructors

AsyncUnaryCall(Task<TResponse>, Func<object, Task<Metadata>>, Func<object, Status>, Func<object, Metadata>, Action<object>, object)

public AsyncUnaryCall(Task<TResponse> responseAsync, Func<object, Task<Metadata>> responseHeadersAsync, Func<object, Status> getStatusFunc, Func<object, Metadata> getTrailersFunc, Action<object> disposeAction, object state)

Creates a new AsyncUnaryCall object with the specified properties.

Parameters
Name Description
responseAsync Task

The response of the asynchronous call.

responseHeadersAsync FuncobjectTaskMetadata

Response headers of the asynchronous call.

getStatusFunc FuncobjectStatus

Delegate returning the status of the call.

getTrailersFunc FuncobjectMetadata

Delegate returning the trailing metadata of the call.

disposeAction Actionobject

Delegate to invoke when Dispose is called on the call object.

state object

State object for use with the callback parameters.

AsyncUnaryCall(Task<TResponse>, Task<Metadata>, Func<Status>, Func<Metadata>, Action)

public AsyncUnaryCall(Task<TResponse> responseAsync, Task<Metadata> responseHeadersAsync, Func<Status> getStatusFunc, Func<Metadata> getTrailersFunc, Action disposeAction)

Creates a new AsyncUnaryCall object with the specified properties.

Parameters
Name Description
responseAsync Task

The response of the asynchronous call.

responseHeadersAsync TaskMetadata

Response headers of the asynchronous call.

getStatusFunc FuncStatus

Delegate returning the status of the call.

getTrailersFunc FuncMetadata

Delegate returning the trailing metadata of the call.

disposeAction Action

Delegate to invoke when Dispose is called on the call object.

Properties

ResponseAsync

public Task<TResponse> ResponseAsync { get; }

Asynchronous call result.

Property Value
Type Description
Task

ResponseHeadersAsync

public Task<Metadata> ResponseHeadersAsync { get; }

Asynchronous access to response headers.

Property Value
Type Description
TaskMetadata

Methods

ConfigureAwait(bool)

public ConfiguredTaskAwaitable<TResponse> ConfigureAwait(bool continueOnCapturedContext)

Configures an awaiter used to await this AsyncUnaryCall<TResponse>.

Parameter
Name Description
continueOnCapturedContext bool

true to attempt to marshal the continuation back to the original context captured; otherwise, false.

Returns
Type Description
ConfiguredTaskAwaitable

An object used to await this task.

Dispose()

public void Dispose()

Provides means to cleanup after the call. If the call has already finished normally (request stream has been completed and call result has been received), doesn't do anything. Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call. As a result, all resources being used by the call should be released eventually.

Remarks

Normally, there is no need for you to dispose the call unless you want to utilize the "Cancel" semantics of invoking Dispose.

GetAwaiter()

public TaskAwaiter<TResponse> GetAwaiter()

Gets an awaiter used to await this AsyncUnaryCall<TResponse>.

Returns
Type Description
TaskAwaiter

An awaiter instance.

Remarks

This method is intended for compiler use rather than use directly in code.

GetStatus()

public Status GetStatus()

Gets the call status if the call has already finished. Throws InvalidOperationException otherwise.

Returns
Type Description
Status

GetTrailers()

public Metadata GetTrailers()

Gets the call trailing metadata if the call has already finished. Throws InvalidOperationException otherwise.

Returns
Type Description
Metadata