Show / Hide Table of Contents

Class AsyncDuplexStreamingCall<TRequest, TResponse>

Return type for bidirectional streaming calls.

Inheritance
System.Object
AsyncDuplexStreamingCall<TRequest, TResponse>
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Grpc.Core
Assembly: Grpc.Core.Api.dll
Syntax
public sealed class AsyncDuplexStreamingCall<TRequest, TResponse> : IDisposable
Type Parameters
Name Description
TRequest

Request message type for this call.

TResponse

Response message type for this call.

Constructors

AsyncDuplexStreamingCall(IClientStreamWriter<TRequest>, IAsyncStreamReader<TResponse>, Task<Metadata>, Func<Status>, Func<Metadata>, Action)

Creates a new AsyncDuplexStreamingCall object with the specified properties.

Declaration
public AsyncDuplexStreamingCall(IClientStreamWriter<TRequest> requestStream, IAsyncStreamReader<TResponse> responseStream, Task<Metadata> responseHeadersAsync, Func<Status> getStatusFunc, Func<Metadata> getTrailersFunc, Action disposeAction)
Parameters
Type Name Description
IClientStreamWriter<TRequest> requestStream

Stream of request values.

IAsyncStreamReader<TResponse> responseStream

Stream of response values.

System.Threading.Tasks.Task<Metadata> responseHeadersAsync

Response headers of the asynchronous call.

System.Func<Status> getStatusFunc

Delegate returning the status of the call.

System.Func<Metadata> getTrailersFunc

Delegate returning the trailing metadata of the call.

System.Action disposeAction

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

Properties

RequestStream

Async stream to send streaming requests.

Declaration
public IClientStreamWriter<TRequest> RequestStream { get; }
Property Value
Type Description
IClientStreamWriter<TRequest>

ResponseHeadersAsync

Asynchronous access to response headers.

Declaration
public Task<Metadata> ResponseHeadersAsync { get; }
Property Value
Type Description
System.Threading.Tasks.Task<Metadata>

ResponseStream

Async stream to read streaming responses.

Declaration
public IAsyncStreamReader<TResponse> ResponseStream { get; }
Property Value
Type Description
IAsyncStreamReader<TResponse>

Methods

Dispose()

Provides means to cleanup after the call. If the call has already finished normally (request stream has been completed and 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.

Declaration
public void Dispose()
Implements
System.IDisposable.Dispose()
Remarks

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

GetStatus()

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

Declaration
public Status GetStatus()
Returns
Type Description
Status

GetTrailers()

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

Declaration
public Metadata GetTrailers()
Returns
Type Description
Metadata
Back to top