FailingClientStream

java.lang.Object

io.grpc.internal.NoopClientStream

io.grpc.internal.FailingClientStream

All Implemented Interfaces:: ClientStream, Stream

public final class FailingClientStream extends NoopClientStream

An implementation of ClientStream that fails (by calling ClientStreamListener.closed(io.grpc.Status, io.grpc.internal.ClientStreamListener.RpcProgress, io.grpc.Metadata)) when started, and silently does nothing for the other operations.

Field Summary

Fields inherited from class io.grpc.internal.NoopClientStream
INSTANCE
Constructor Summary

Constructors

Constructor

Description

FailingClientStream(Status error, ClientStreamTracer[] tracers)

Creates a FailingClientStream that would fail with the given error.

FailingClientStream(Status error, ClientStreamListener.RpcProgress rpcProgress, ClientStreamTracer[] tracers)

Creates a FailingClientStream that would fail with the given error.
Method Summary

Modifier and Type

Method

Description

void

appendTimeoutInsight(InsightBuilder insight)

Append information that will be included in the locally generated DEADLINE_EXCEEDED errors to the given InsightBuilder, in order to tell the user about the state of the stream so that they can better diagnose the cause of the error.

void

start(ClientStreamListener listener)

Starts stream.

Methods inherited from class io.grpc.internal.NoopClientStream
cancel, flush, getAttributes, halfClose, isReady, optimizeForDirectExecutor, request, setAuthority, setCompressor, setDeadline, setDecompressorRegistry, setFullStreamDecompression, setMaxInboundMessageSize, setMaxOutboundMessageSize, setMessageCompression, writeMessage

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- FailingClientStream
  
  public FailingClientStream(Status error, ClientStreamTracer[] tracers)
  
  Creates a FailingClientStream that would fail with the given error.
- FailingClientStream
  
  public FailingClientStream(Status error, ClientStreamListener.RpcProgress rpcProgress, ClientStreamTracer[] tracers)
  
  Creates a FailingClientStream that would fail with the given error.
Method Details
- start
  
  public void start(ClientStreamListener listener)
  
  Description copied from interface: ClientStream
  
  Starts stream. This method may only be called once. It is safe to do latent initialization of the stream up until ClientStream.start(io.grpc.internal.ClientStreamListener) is called.
  This method should not throw any exceptions.
  
  Specified by:
  
  start in interface ClientStream
  
  Overrides:
  
  start in class NoopClientStream
  
  Parameters:
  
  listener - non-null listener of stream events
- appendTimeoutInsight
  
  public void appendTimeoutInsight(InsightBuilder insight)
  
  Description copied from interface: ClientStream
  
  Append information that will be included in the locally generated DEADLINE_EXCEEDED errors to the given InsightBuilder, in order to tell the user about the state of the stream so that they can better diagnose the cause of the error.
  
  Specified by:
  
  appendTimeoutInsight in interface ClientStream
  
  Overrides:
  
  appendTimeoutInsight in class NoopClientStream