io.grpc.internal

Interface ClientStream

All Superinterfaces:

Stream

All Known Implementing Classes:

AbstractClientStream, Http2ClientStream

public interface ClientStream
extends Stream

Extension of Stream to support client-side termination semantics.

An implementation doesn't need to be thread-safe. All methods are expected to execute quickly.

Method Summary

Modifier and Type	Method and Description
void	cancel(Status reason) Abnormally terminates the stream.
void	halfClose() Closes the local side of this stream and flushes any remaining messages.

Methods inherited from interface io.grpc.internal.Stream

flush, isReady, request, writeMessage

Method Detail

cancel

void cancel(Status reason)

Abnormally terminates the stream. After calling this method, no further messages will be sent or received, however it may still be possible to receive buffered messages for a brief period until ClientStreamListener.closed(io.grpc.Status, io.grpc.Metadata.Trailers) is called. This method is safe to be called at any time and multiple times.

Parameters:

reason - must be one of Status.CANCELLED or Status.DEADLINE_EXCEEDED

halfClose

void halfClose()

Closes the local side of this stream and flushes any remaining messages. After this is called, no further messages may be sent on this stream, but additional messages may be received until the remote end-point is closed. This method may only be called once.