io.grpc.internal

Class AbstractServerStream<IdT>

java.lang.Object

io.grpc.internal.AbstractStream<IdT>

io.grpc.internal.AbstractServerStream<IdT>

Type Parameters:

IdT - the type of the stream identifier

All Implemented Interfaces:

ServerStream, Stream

public abstract class AbstractServerStream<IdT>
extends AbstractStream<IdT>
implements ServerStream

Abstract base class for ServerStream implementations.

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.internal.AbstractStream

AbstractStream.Phase

Field Summary

Fields inherited from class io.grpc.internal.AbstractStream

DEFAULT_ONREADY_THRESHOLD

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractServerStream(WritableBufferAllocator bufferAllocator)

Method Summary

Modifier and Type	Method and Description
void	abortStream(Status status, boolean notifyClient) Aborts the stream with an error status, cleans up resources and notifies the listener if necessary.
void	close(Status status, Metadata.Trailers trailers) Closes the stream for both reading and writing.
void	complete() Indicates the stream is considered completely closed and there is no further opportunity for error.
protected void	deframeFailed(Throwable cause) Called when a AbstractStream.deframe(ReadableBuffer, boolean) operation failed.
void	inboundDataReceived(ReadableBuffer frame, boolean endOfStream) Called in the network thread to process the content of an inbound DATA frame from the client.
protected void	internalSendFrame(WritableBuffer frame, boolean endOfStream, boolean flush) Sends an outbound frame to the remote end point.
protected abstract void	internalSendHeaders(Metadata.Headers headers) Sends response headers to the remote end points.
boolean	isClosed() Whether the stream is fully closed.
protected ServerStreamListener	listener() Override this method to provide a stream listener.
protected void	receiveMessage(InputStream is) Handles a message that was just deframed.
protected void	remoteEndClosed() Called when the remote end half-closes the stream.
protected abstract void	sendFrame(WritableBuffer frame, boolean endOfStream, boolean flush) Sends an outbound frame to the remote end point.
protected abstract void	sendTrailers(Metadata.Trailers trailers, boolean headersSent) Sends trailers to the remote end point.
void	setListener(ServerStreamListener listener) Sets the listener to receive notifications.
void	writeHeaders(Metadata.Headers headers) Writes custom metadata as headers on the response stream sent to the client.
void	writeMessage(InputStream message) Writes a message payload to the remote end-point.

Methods inherited from class io.grpc.internal.AbstractStream

canReceive, canSend, closeDeframer, deframe, dispose, flush, getOnReadyThreshold, id, inboundDeliveryPaused, isDeframerStalled, isReady, onSendingBytes, onSentBytes, onStreamAllocated, requestMessagesFromDeframer, returnProcessedBytes, toString, toStringHelper

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.grpc.internal.ServerStream

cancel

Methods inherited from interface io.grpc.internal.Stream

flush, isReady, request

Constructor Detail

AbstractServerStream

protected AbstractServerStream(WritableBufferAllocator bufferAllocator)

Method Detail

setListener

public final void setListener(ServerStreamListener listener)

Sets the listener to receive notifications. Must be called in the context of the transport thread.

listener

protected ServerStreamListener listener()

Description copied from class: AbstractStream

Override this method to provide a stream listener.

Specified by:

listener in class AbstractStream<IdT>

receiveMessage

protected void receiveMessage(InputStream is)

Description copied from class: AbstractStream

Handles a message that was just deframed.

Specified by:

receiveMessage in class AbstractStream<IdT>

Parameters:

is - the stream containing the message

writeHeaders

public final void writeHeaders(Metadata.Headers headers)

Description copied from interface: ServerStream

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 ServerStream.close(io.grpc.Status, io.grpc.Metadata.Trailers).

Specified by:

writeHeaders in interface ServerStream

Parameters:

headers - to send to client.

writeMessage

public final void writeMessage(InputStream message)

Description copied from interface: Stream

Writes a message payload to the remote end-point. The bytes from the stream are immediately read by the Transport. Where possible callers should use streams that are KnownLength to improve efficiency. This method will always return immediately and will not wait for the write to complete.

When the write is "accepted" by the transport, the given callback (if provided) will be called. The definition of what it means to be "accepted" is up to the transport implementation, but this is a general indication that the transport is capable of handling more out-bound data on the stream. If the stream/connection is closed for any reason before the write could be accepted, the callback will never be invoked.

Specified by:

writeMessage in interface Stream

Overrides:

writeMessage in class AbstractStream<IdT>

Parameters:

message - stream containing the serialized message to be sent

close

public final void close(Status status,
                        Metadata.Trailers trailers)

Description copied from interface: ServerStream

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.

Specified by:

close in interface ServerStream

Parameters:

status - details of the closure

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

inboundDataReceived

public void inboundDataReceived(ReadableBuffer frame,
                                boolean endOfStream)

Called in the network thread to process the content of an inbound DATA frame from the client.

Parameters:

frame - the inbound HTTP/2 DATA frame. If this buffer is not used immediately, it must be retained.

endOfStream - true if no more data will be received on the stream.

deframeFailed

protected final void deframeFailed(Throwable cause)

Description copied from class: AbstractStream

Called when a AbstractStream.deframe(ReadableBuffer, boolean) operation failed.

Specified by:

deframeFailed in class AbstractStream<IdT>

Parameters:

cause - the actual failure

internalSendFrame

protected final void internalSendFrame(WritableBuffer frame,
                                       boolean endOfStream,
                                       boolean flush)

Description copied from class: AbstractStream

Sends an outbound frame to the remote end point.

Specified by:

internalSendFrame in class AbstractStream<IdT>

Parameters:

frame - a buffer containing the chunk of data to be sent.

endOfStream - if true indicates that no more data will be sent on the stream by this endpoint.

flush - true if more data may not be arriving soon

internalSendHeaders

protected abstract void internalSendHeaders(Metadata.Headers headers)

Sends response headers to the remote end points.

Parameters:

headers - the headers to be sent to client.

sendFrame

protected abstract void sendFrame(WritableBuffer frame,
                                  boolean endOfStream,
                                  boolean flush)

Sends an outbound frame to the remote end point.

Parameters:

frame - a buffer containing the chunk of data to be sent.

endOfStream - if true indicates that no more data will be sent on the stream by this endpoint.

flush - true if more data may not be arriving soon

sendTrailers

protected abstract void sendTrailers(Metadata.Trailers trailers,
                                     boolean headersSent)

Sends trailers to the remote end point. This call implies end of stream.

Parameters:

trailers - metadata to be sent to end point

headersSent - true if response headers have already been sent.

complete

public void complete()

Indicates the stream is considered completely closed and there is no further opportunity for error. It calls the listener's closed() if it was not already done by abortStream(io.grpc.Status, boolean). Note that it is expected that either closed() or abortStream() was previously called, since closed() is required for a normal stream closure and abortStream() for abnormal.

remoteEndClosed

protected final void remoteEndClosed()

Called when the remote end half-closes the stream.

Specified by:

remoteEndClosed in class AbstractStream<IdT>

abortStream

public final void abortStream(Status status,
                              boolean notifyClient)

Aborts the stream with an error status, cleans up resources and notifies the listener if necessary.

Unlike close(Status, Metadata.Trailers), this method is only called from the transport. The transport should use this method instead of close(Status) for internal errors to prevent exposing unexpected states and exceptions to the application.

Parameters:

status - the error status. Must not be Status.OK.

notifyClient - true if the stream is still writable and you want to notify the client about stream closure and send the status

isClosed

public boolean isClosed()

Description copied from class: AbstractStream

Whether the stream is fully closed. Note that this method is not thread-safe as inboundPhase and outboundPhase are mutated in different threads. Tests must account for thread coordination when calling.

Overrides:

isClosed in class AbstractStream<IdT>