io.grpc.internal

Interface ServerStream

All Superinterfaces:

Stream

All Known Implementing Classes:

AbstractServerStream

public interface ServerStream
extends Stream

Extension of Stream to support server-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 status) Tears down the stream, typically in the event of a timeout.
void	close(Status status, Metadata.Trailers trailers) Closes the stream for both reading and writing.
void	writeHeaders(Metadata.Headers headers) Writes custom metadata as headers on the response stream sent to the client.

Methods inherited from interface io.grpc.internal.Stream

flush, isReady, request, writeMessage

Method Detail

writeHeaders

void writeHeaders(Metadata.Headers headers)

Writes custom metadata as headers on the response stream sent to the client. This method may only be called once and cannot be called after calls to Stream.writeMessage(java.io.InputStream) or close(io.grpc.Status, io.grpc.Metadata.Trailers).

Parameters:

headers - to send to client.

close

void close(Status status,
           Metadata.Trailers trailers)

Closes the stream for both reading and writing. A status code of Status.Code.OK implies normal termination of the stream. Any other value implies abnormal termination.

Parameters:

status - details of the closure

trailers - an additional block of metadata to pass to the client on stream closure.

cancel

void cancel(Status status)

Tears down the stream, typically in the event of a timeout. This method may be called multiple times and from any thread.