io.grpc.internal

Interface ClientStream

All Superinterfaces:

Stream

All Known Implementing Classes:

AbstractClientStream, FailingClientStream, NoopClientStream

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(io.grpc.Status reason) Abnormally terminates the stream.
io.grpc.Attributes	getAttributes() Attributes that the stream holds at the current moment.
void	halfClose() Closes the local side of this stream and flushes any remaining messages.
void	setAuthority(String authority) Override the default authority with authority.
void	setDeadline(io.grpc.Deadline deadline) Sets the effective deadline of the RPC.
void	setDecompressorRegistry(io.grpc.DecompressorRegistry decompressorRegistry) Sets the registry to find a decompressor for the framer.
void	setFullStreamDecompression(boolean fullStreamDecompression) Enables full-stream decompression, allowing the client stream to use GzipInflatingBuffer to decode inbound GZIP compressed streams.
void	setMaxInboundMessageSize(int maxSize) Sets the max size accepted from the remote endpoint.
void	setMaxOutboundMessageSize(int maxSize) Sets the max size sent to the remote endpoint.
void	start(ClientStreamListener listener) Starts stream.

Methods inherited from interface io.grpc.internal.Stream

flush, isReady, request, setCompressor, setMessageCompression, writeMessage

Method Detail

cancel

void cancel(io.grpc.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) is called. This method may only be called after start(io.grpc.internal.ClientStreamListener), but else is safe to be called at any time and multiple times and from any thread.

Parameters:

reason - must be non-OK

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, and only after start(io.grpc.internal.ClientStreamListener).

setAuthority

void setAuthority(String authority)

Override the default authority with authority. May only be called before start(io.grpc.internal.ClientStreamListener).

setFullStreamDecompression

void setFullStreamDecompression(boolean fullStreamDecompression)

Enables full-stream decompression, allowing the client stream to use GzipInflatingBuffer to decode inbound GZIP compressed streams.

setDecompressorRegistry

void setDecompressorRegistry(io.grpc.DecompressorRegistry decompressorRegistry)

Sets the registry to find a decompressor for the framer. May only be called before start(io.grpc.internal.ClientStreamListener). If the transport does not support compression, this may do nothing.

Parameters:

decompressorRegistry - the registry of decompressors for decoding responses

start

void start(ClientStreamListener listener)

Starts stream. This method may only be called once. It is safe to do latent initialization of the stream up until start(io.grpc.internal.ClientStreamListener) is called.

This method should not throw any exceptions.

Parameters:

listener - non-null listener of stream events

setMaxInboundMessageSize

void setMaxInboundMessageSize(int maxSize)

Sets the max size accepted from the remote endpoint.

setMaxOutboundMessageSize

void setMaxOutboundMessageSize(int maxSize)

Sets the max size sent to the remote endpoint.

setDeadline

void setDeadline(@Nonnull
                 io.grpc.Deadline deadline)

Sets the effective deadline of the RPC.

getAttributes

io.grpc.Attributes getAttributes()

Attributes that the stream holds at the current moment.