Class AsyncServerStreamingCall<TResponse>

public sealed class AsyncServerStreamingCall<TResponse> : IDisposable

Return type for server streaming calls.

Inheritance

Object > AsyncServerStreamingCall<TResponse>

Namespace

Grpc.Core

Assembly

Grpc.Core.Api.dll

Type Parameter

NameDescription
TResponse

Response message type for this call.

Constructors

AsyncServerStreamingCall(IAsyncStreamReader<TResponse>, Func<Object, Task<Metadata>>, Func<Object, Status>, Func<Object, Metadata>, Action<Object>, Object)

public AsyncServerStreamingCall(IAsyncStreamReader<TResponse> responseStream, Func<object, Task<Metadata>> responseHeadersAsync, Func<object, Status> getStatusFunc, Func<object, Metadata> getTrailersFunc, Action<object> disposeAction, object state)

Creates a new AsyncDuplexStreamingCall object with the specified properties.

Parameters
TypeNameDescription
IAsyncStreamReader<TResponse>responseStream

Stream of response values.

Func<Object, Task<Metadata>>responseHeadersAsync

Response headers of the asynchronous call.

Func<Object, Status>getStatusFunc

Delegate returning the status of the call.

Func<Object, Metadata>getTrailersFunc

Delegate returning the trailing metadata of the call.

Action<Object>disposeAction

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

Objectstate

State object for use with the callback parameters.

AsyncServerStreamingCall(IAsyncStreamReader<TResponse>, Task<Metadata>, Func<Status>, Func<Metadata>, Action)

public AsyncServerStreamingCall(IAsyncStreamReader<TResponse> responseStream, Task<Metadata> responseHeadersAsync, Func<Status> getStatusFunc, Func<Metadata> getTrailersFunc, Action disposeAction)

Creates a new AsyncDuplexStreamingCall object with the specified properties.

Parameters
TypeNameDescription
IAsyncStreamReader<TResponse>responseStream

Stream of response values.

Task<Metadata>responseHeadersAsync

Response headers of the asynchronous call.

Func<Status>getStatusFunc

Delegate returning the status of the call.

Func<Metadata>getTrailersFunc

Delegate returning the trailing metadata of the call.

ActiondisposeAction

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

Properties

ResponseHeadersAsync

public Task<Metadata> ResponseHeadersAsync { get; }

Asynchronous access to response headers.

Property Value
TypeDescription
Task<Metadata>

ResponseStream

public IAsyncStreamReader<TResponse> ResponseStream { get; }

Async stream to read streaming responses.

Property Value
TypeDescription
IAsyncStreamReader<TResponse>

Methods

Dispose()

public void Dispose()

Provides means to cleanup after the call. If the call has already finished normally (response stream has been fully read), 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.

GetStatus()

public Status GetStatus()

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

Returns
TypeDescription
Status

GetTrailers()

public Metadata GetTrailers()

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

Returns
TypeDescription
Metadata