io.grpc.transport

Class AbstractClientStream<IdT>

java.lang.Object

io.grpc.transport.AbstractStream<IdT>

io.grpc.transport.AbstractClientStream<IdT>

All Implemented Interfaces:

ClientStream, Stream

Direct Known Subclasses:

Http2ClientStream

public abstract class AbstractClientStream<IdT>
extends AbstractStream<IdT>
implements ClientStream

The abstract base class for ClientStream implementations.

Nested Class Summary

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

AbstractStream.Phase

Field Summary

Fields inherited from class io.grpc.transport.AbstractStream

DEFAULT_ONREADY_THRESHOLD

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractClientStream(WritableBufferAllocator bufferAllocator, ClientStreamListener listener) Constructor used by subclasses.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel the stream.
protected void	deframeFailed(Throwable cause) Called when a AbstractStream.deframe(ReadableBuffer, boolean) operation failed.
void	halfClose() Closes the local side of this stream and flushes any remaining messages.
protected void	inboundDataReceived(ReadableBuffer frame) Processes the contents of a received data frame from the server.
protected void	inboundDeliveryPaused() Handles the event that the deframer has no pending deliveries.
protected void	inboundHeadersReceived(Metadata.Headers headers) Called by transport implementations when they receive headers.
protected void	inboundTrailersReceived(Metadata.Trailers trailers, Status status) Processes the trailers and status from the server.
protected void	inboundTransportError(Status errorStatus) The transport implementation has detected a protocol error on the stream.
protected void	internalSendFrame(WritableBuffer frame, boolean endOfStream, boolean flush) Sends an outbound frame to the remote end point.
boolean	isClosed() Whether the stream is fully closed.
protected ClientStreamListener	listener() Gets the listener to this stream.
protected void	receiveMessage(InputStream is) Handles a message that was just deframed.
protected void	remoteEndClosed() Handles the event that the deframer has reached end of stream.
protected abstract void	sendCancel() Cancel the stream and send a stream cancellation message to the remote server, if necessary.
protected abstract void	sendFrame(WritableBuffer frame, boolean endOfStream, boolean flush) Sends an outbound frame to the remote end point.
protected Objects.ToStringHelper	toStringHelper()
void	transportReportStatus(Status newStatus, boolean stopDelivery, Metadata.Trailers trailers) Report stream closure with status to the application layer if not already reported.

Methods inherited from class io.grpc.transport.AbstractStream

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.grpc.transport.Stream

flush, isReady, request, writeMessage

Constructor Detail

AbstractClientStream

protected AbstractClientStream(WritableBufferAllocator bufferAllocator,
                               ClientStreamListener listener)

Constructor used by subclasses.

Parameters:

listener - the listener to receive notifications

Method Detail

listener

protected final ClientStreamListener listener()

Description copied from class: AbstractStream

Gets the listener to this stream.

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

inboundTransportError

protected void inboundTransportError(Status errorStatus)

The transport implementation has detected a protocol error on the stream. Transports are responsible for properly closing streams when protocol errors occur.

Parameters:

errorStatus - the error to report

inboundHeadersReceived

protected void inboundHeadersReceived(Metadata.Headers headers)

Called by transport implementations when they receive headers. When receiving headers a transport may determine that there is an error in the protocol at this phase which is why this method takes an error Status. If a transport reports an Status.Code.INTERNAL error

Parameters:

headers - the parsed headers

inboundDataReceived

protected void inboundDataReceived(ReadableBuffer frame)

Processes the contents of a received data frame from the server.

Parameters:

frame - the received data frame. Its ownership is transferred to this method.

inboundDeliveryPaused

protected void inboundDeliveryPaused()

Description copied from class: AbstractStream

Handles the event that the deframer has no pending deliveries.

Specified by:

inboundDeliveryPaused in class AbstractStream<IdT>

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

inboundTrailersReceived

protected void inboundTrailersReceived(Metadata.Trailers trailers,
                                       Status status)

Processes the trailers and status from the server.

Parameters:

trailers - the received trailers

status - the status extracted from the trailers

remoteEndClosed

protected void remoteEndClosed()

Description copied from class: AbstractStream

Handles the event that the deframer has reached end of stream.

Specified by:

remoteEndClosed in class AbstractStream<IdT>

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

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 or null if the framer is closing and has no data to send.

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

transportReportStatus

public void transportReportStatus(Status newStatus,
                                  boolean stopDelivery,
                                  Metadata.Trailers trailers)

Report stream closure with status to the application layer if not already reported. This method must be called from the transport thread.

Parameters:

newStatus - the new status to set

stopDelivery - if true, interrupts any further delivery of inbound messages that may already be queued up in the deframer. If false, the listener will be notified immediately after all currently completed messages in the deframer have been delivered to the application.

trailers - new instance of Trailers, either empty or those returned by the server

halfClose

public final void halfClose()

Description copied from interface: ClientStream

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.

Specified by:

halfClose in interface ClientStream

cancel

public void cancel()

Cancel the stream. Called by the application layer, never called by the transport.

Specified by:

cancel in interface ClientStream

sendCancel

protected abstract void sendCancel()

Cancel the stream and send a stream cancellation message to the remote server, if necessary. Can be called by either the application or transport layers. This method is safe to be called at any time and multiple times.

toStringHelper

protected Objects.ToStringHelper toStringHelper()

Overrides:

toStringHelper in class AbstractStream<IdT>

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>