Top Description Constructors Methods
io.grpc

pack-priv abstract Class PartialForwardingServerCallListener<ReqT>

extends ServerCall.Listener<ReqT>
Class Inheritance
Known Direct Subclasses
io.grpc.ForwardingServerCallListener
Imports
com.google.common.base.MoreObjects

A ServerCall.Listener which forwards all of its methods to another ServerCall.Listener which may have a different parameterized type than the onMessage() message type.

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
protected abstract ServerCall.Listener<?>
delegate()

Returns the delegated ServerCall.Listener.

public void
onCancel()

Overrides io.grpc.ServerCall.Listener.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.
public void
onComplete()

Overrides io.grpc.ServerCall.Listener.onComplete.

The call is considered complete and onCancel is guaranteed not to be called.
public void
onHalfClose()

Overrides io.grpc.ServerCall.Listener.onHalfClose.

The client completed all message sending.
public void
onReady()

Overrides io.grpc.ServerCall.Listener.onReady.

This indicates that the call may now be capable of sending additional messages (via sendMessage) without requiring excessive buffering internally.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from io.grpc.ServerCall.Listener:
onMessage

Constructor Detail

PartialForwardingServerCallListenerback to summary
pack-priv PartialForwardingServerCallListener()

Method Detail

delegateback to summary
protected abstract ServerCall.Listener<?> delegate()

Returns the delegated ServerCall.Listener.

onCancelback to summary
public void onCancel()

Overrides io.grpc.ServerCall.Listener.onCancel.

Doc from io.grpc.ServerCall.Listener.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.

Annotations
@Override
onCompleteback to summary
public void onComplete()

Overrides io.grpc.ServerCall.Listener.onComplete.

Doc from io.grpc.ServerCall.Listener.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.

Annotations
@Override
onHalfCloseback to summary
public void onHalfClose()

Overrides io.grpc.ServerCall.Listener.onHalfClose.

Doc from io.grpc.ServerCall.Listener.onHalfClose.

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

Annotations
@Override
onReadyback to summary
public void onReady()

Overrides io.grpc.ServerCall.Listener.onReady.

Doc from io.grpc.ServerCall.Listener.onReady.

This indicates that the call may now be capable of sending additional messages (via sendMessage) 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.

Because there is a processing delay to deliver this notification, it is possible for concurrent writes to cause isReady() == false within this callback. Handle "spurious" notifications by checking isReady()'s current value instead of assuming it is now true. If isReady() == false the normal expectations apply, so there would be another onReady() callback.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override