Class ServerImpl.JumpToApplicationThreadServerStreamListener

java.lang.Object

io.grpc.internal.ServerImpl.JumpToApplicationThreadServerStreamListener

All Implemented Interfaces:

ServerStreamListener, StreamListener

Enclosing class:

ServerImpl

static final class ServerImpl.JumpToApplicationThreadServerStreamListener
extends Object
implements ServerStreamListener

Dispatches callbacks onto an application-provided executor and correctly propagates exceptions.

Nested Class Summary

Nested classes/interfaces inherited from interface StreamListener

StreamListener.MessageProducer

Field Summary

Fields

Modifier and Type	Field	Description
private final Executor	callExecutor
private final Executor	cancelExecutor
private final Context.CancellableContext	context
private ServerStreamListener	listener
private final ServerStream	stream
private final io.perfmark.Tag	tag

Constructor Summary

Constructors

Constructor	Description
JumpToApplicationThreadServerStreamListener(Executor executor, Executor cancelExecutor, ServerStream stream, Context.CancellableContext context, io.perfmark.Tag tag)

Method Summary

Modifier and Type	Method	Description
void	closed(Status status)	Called when the stream is fully closed.
private void	closedInternal(Status status)
private ServerStreamListener	getListener()	This call MUST be serialized on callExecutor to avoid races.
void	halfClosed()	Called when the remote side of the transport gracefully closed, indicating the client had no more data to send.
private void	internalClose(Throwable t)	Like ServerCall.close(Status, Metadata), but thread-safe for internal use.
void	messagesAvailable(StreamListener.MessageProducer producer)	Called upon receiving a message from the remote end-point.
void	onReady()	This indicates that the transport is now capable of sending additional messages without requiring excessive buffering internally.
(package private) void	setListener(ServerStreamListener listener)

Methods inherited from class Object

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

Field Details

callExecutor

private final Executor callExecutor

cancelExecutor

private final Executor cancelExecutor

context

private final Context.CancellableContext context

stream

private final ServerStream stream

tag

private final io.perfmark.Tag tag

listener

private ServerStreamListener listener

Constructor Details

JumpToApplicationThreadServerStreamListener

public JumpToApplicationThreadServerStreamListener(Executor executor,
 Executor cancelExecutor,
 ServerStream stream,
 Context.CancellableContext context,
 io.perfmark.Tag tag)

Method Details

getListener

private ServerStreamListener getListener()

This call MUST be serialized on callExecutor to avoid races.

setListener

void setListener(ServerStreamListener listener)

internalClose

private void internalClose(Throwable t)

Like ServerCall.close(Status, Metadata), but thread-safe for internal use.

messagesAvailable

public void messagesAvailable(StreamListener.MessageProducer producer)

Description copied from interface: StreamListener

Called upon receiving a message from the remote end-point.

Implementations must eventually drain the provided producer StreamListener.MessageProducer completely by invoking StreamListener.MessageProducer.next() to obtain deframed messages until the producer returns null.

This method should return quickly, as the same thread may be used to process other streams.

Specified by:

messagesAvailable in interface StreamListener

Parameters:

producer - supplier of deframed messages.

halfClosed

public void halfClosed()

Description copied from interface: ServerStreamListener

Called when the remote side of the transport gracefully closed, indicating the client had no more data to send. No further messages will be received on the stream.

This method should return quickly, as the same thread may be used to process other streams.

Specified by:

halfClosed in interface ServerStreamListener

closed

public void closed(Status status)

Description copied from interface: ServerStreamListener

Called when the stream is fully closed. A status code of Status.Code.OK implies normal termination of the stream. Any other value implies abnormal termination. Since clients cannot send status, the passed status is always library-generated and only is concerned with transport-level stream shutdown (the call itself may have had a failing status, but if the stream terminated cleanly with the status appearing to have been sent, then the passed status here would be OK). This is guaranteed to always be the final call on a listener. No further callbacks will be issued.

This method should return quickly, as the same thread may be used to process other streams.

Specified by:

closed in interface ServerStreamListener

Parameters:

status - details about the remote closure

closedInternal

private void closedInternal(Status status)

onReady

public void onReady()

Description copied from interface: StreamListener

This indicates that the transport is now capable of sending additional messages without requiring excessive buffering internally. This event is just a suggestion and the application is free to ignore it, however doing so may result in excessive buffering within the transport.

Specified by:

onReady in interface StreamListener