io.grpc

Class ClientCall.Listener<T>

java.lang.Object

io.grpc.ClientCall.Listener<T>

Direct Known Subclasses:

ForwardingClientCallListener

Enclosing class:

ClientCall<RequestT,ResponseT>

public abstract static class ClientCall.Listener<T>
extends Object

Callbacks for receiving metadata, response messages and completion status from the server.

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	onClose(Status status, Metadata.Trailers trailers) The ClientCall has been closed.
abstract void	onHeaders(Metadata.Headers headers) The response headers have been received.
abstract void	onMessage(T message) A response message has been received.
void	onReady() This indicates that the ClientCall is now capable of sending additional messages (via ClientCall.sendMessage(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

Listener

public Listener()

Method Detail

onHeaders

public abstract void onHeaders(Metadata.Headers headers)

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

Parameters:

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

onMessage

public abstract void onMessage(T message)

A response message 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.

Parameters:

message - returned by the server

onClose

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

The ClientCall has been closed. Any additional calls to the ClientCall will not be processed by the server. No further receiving will occur and no further notifications will be made.

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.

Parameters:

status - the result of the remote call.

trailers - metadata provided at call completion.

onReady

public void onReady()

This indicates that the ClientCall is now capable of sending additional messages (via ClientCall.sendMessage(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 ClientCall.