Class ClientStreamingBase<TRequest, TResponse> (4.8.0)

public abstract class ClientStreamingBase<TRequest, TResponse> : IDisposable

Base class for the client-side streaming RPC methods. This wraps the request stream in a buffer, allowing multiple requests to be written without waiting for them to be transmitted.

Inheritance

object > ClientStreamingBase<TRequest, TResponse>

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace

Google.Api.Gax.Grpc

Assembly

Google.Api.Gax.Grpc.dll

Type Parameters
Name	Description
`TRequest`	RPC request type
`TResponse`	RPC response type

Remarks

To avoid memory leaks, users must dispose of gRPC streams.

Properties

GrpcCall

public virtual AsyncClientStreamingCall<TRequest, TResponse> GrpcCall { get; }

The underlying gRPC client streaming call. Warning: DO NOT USE GrpcCall.RequestStream at all if using TryWriteAsync(TRequest), WriteAsync(TRequest), TryWriteAsync(TRequest, WriteOptions) , or WriteAsync(TRequest, WriteOptions). Doing so will cause conflict with the write-buffer used within the [Try]WriteAsync methods.

Property Value
Type	Description
`AsyncClientStreamingCall`

ResponseAsync

public Task<TResponse> ResponseAsync { get; }

Asynchronous call result. This task will only complete after WriteCompleteAsync() has already been called.

Property Value
Type	Description
`Task`	A task representing the asynchronous operation. The result of the completed task will be the RPC response.

Methods

Dispose()

public virtual void Dispose()

Disposes of the underlying gRPC call. There is no need to dispose of both the wrapper and the underlying call; it's typically simpler to dispose of the wrapper with a

using

statement as the wrapper is returned by client libraries.

Remarks

The default implementation just calls Dispose on the result of GrpcCall.

TryWriteAsync(TRequest)

public virtual Task TryWriteAsync(TRequest message)

Writes a message to the stream, if there is enough space in the buffer and WriteCompleteAsync() hasn't already been called. The same write options will be used as for the previous message.

Parameter
Name	Description
`message`	`TRequest` The message to write.

Returns
Type	Description
`Task`	`null` if the message queue is full or the stream has already been completed; otherwise, a Task which will complete when the message has been written to the stream.

TryWriteAsync(TRequest, WriteOptions)

public virtual Task TryWriteAsync(TRequest message, WriteOptions options)

Writes a message to the stream, if there is enough space in the buffer and WriteCompleteAsync() hasn't already been called.

Parameters
Name	Description
`message`	`TRequest` The message to write.
`options`	`WriteOptions` The write options to use for this message.

Returns
Type	Description
`Task`	`null` if the message queue is full or the stream has already been completed.

TryWriteCompleteAsync()

public virtual Task TryWriteCompleteAsync()

Completes the stream when all buffered messages have been sent. Only the first call to this method on any instance will have any effect; subsequent calls will return null.

Returns
Type	Description
`Task`	A Task which will complete when the stream has finished being completed; or `null` if this method has already been called.

WriteAsync(TRequest)

public virtual Task WriteAsync(TRequest message)