io.grpc

Class ServerCall.Listener<RequestT>

java.lang.Object

io.grpc.ServerCall.Listener<RequestT>

Direct Known Subclasses:

ForwardingServerCallListener

Enclosing class:

ServerCall<ResponseT>

public abstract static class ServerCall.Listener<RequestT>
extends Object

Callbacks for consuming incoming RPC messages.

Any contexts are guaranteed to arrive before any payloads, which are guaranteed before half close, which is guaranteed before completion.

Implementations are free to block for extended periods of time. Implementations are not required to be thread-safe.

Constructor Summary

Constructors

Constructor and Description
Listener()

Method Summary

Modifier and Type	Method and Description
abstract void	onCancel() The call was cancelled and the server is encouraged to abort processing to save resources, since the client will not process any further messages.
abstract void	onComplete() The call is considered complete and onCancel() is guaranteed not to be called.
abstract void	onHalfClose() The client completed all message sending.
abstract void	onPayload(RequestT payload) A request message has been received.
void	onReady() This indicates that the call is now capable of sending additional messages (via ServerCall.sendPayload(ResponseT)) without requiring excessive buffering internally.

Methods inherited from class java.lang.Object

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

Constructor Detail

Listener

public Listener()

Method Detail

onPayload

public abstract void onPayload(RequestT payload)

A request message has been received. For streaming calls, there may be zero or more request messages.

Parameters:

payload - a received request message.

onHalfClose

public abstract void onHalfClose()

The client completed all message sending. However, the call may still be cancelled.

onCancel

public abstract void onCancel()

The call was cancelled and the server is encouraged to abort processing to save resources, since the client will not process any further messages. Cancellations can be caused by timeouts, explicit cancellation by the client, network errors, etc.

There will be no further callbacks for the call.

onComplete

public abstract void onComplete()

The call is considered complete and onCancel() is guaranteed not to be called. However, the client is not guaranteed to have received all messages.

There will be no further callbacks for the call.

onReady

public void onReady()

This indicates that the call is now capable of sending additional messages (via ServerCall.sendPayload(ResponseT)) 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 call.