io.grpc

Class ForwardingCallListener<RespT>

java.lang.Object

io.grpc.Call.Listener<RespT>

io.grpc.ForwardingCallListener<RespT>

Direct Known Subclasses:

ForwardingCallListener.SimpleForwardingCallListener

public abstract class ForwardingCallListener<RespT>
extends Call.Listener<RespT>

A Call.Listener which forwards all of its methods to another Call.Listener.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ForwardingCallListener.SimpleForwardingCallListener<RespT> A simplified version of ForwardingCallListener where subclasses can pass in a Call.Listener as the delegate.

Constructor Summary

Constructors

Constructor and Description
ForwardingCallListener()

Method Summary

Modifier and Type	Method and Description
protected abstract Call.Listener<RespT>	delegate() Returns the delegated Call.Listener.
void	onClose(Status status, Metadata.Trailers trailers) The Call has been closed.
void	onHeaders(Metadata.Headers headers) The response headers have been received.
void	onPayload(RespT payload) A response payload has been received.
void	onReady() This indicates that the Call is now capable of sending additional messages (via Call.sendPayload(RequestT)) 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

ForwardingCallListener

public ForwardingCallListener()

Method Detail

delegate

protected abstract Call.Listener<RespT> delegate()

Returns the delegated Call.Listener.

onHeaders

public void onHeaders(Metadata.Headers headers)

Description copied from class: Call.Listener

The response headers have been received. Headers always precede payloads. This method is always called, if no headers were received then an empty Metadata is passed.

Specified by:

onHeaders in class Call.Listener<RespT>

Parameters:

headers - containing metadata sent by the server at the start of the response.

onPayload

public void onPayload(RespT payload)

Description copied from class: Call.Listener

A response payload has been received. May be called zero or more times depending on whether the call response is empty, a single message or a stream of messages.

Specified by:

onPayload in class Call.Listener<RespT>

Parameters:

payload - returned by the server

onClose

public void onClose(Status status,
                    Metadata.Trailers trailers)

Description copied from class: Call.Listener

The Call has been closed. No further sending or receiving can occur. If status is not equal to Status.OK, then the call failed. An additional block of trailer metadata may be received at the end of the call from the server. An empty Metadata object is passed if no trailers are received.

Specified by:

onClose in class Call.Listener<RespT>

Parameters:

status - the result of the remote call.

trailers - metadata provided at call completion.

onReady

public void onReady()

Description copied from class: Call.Listener

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

Overrides:

onReady in class Call.Listener<RespT>