Class ForwardingClientCallListener.SimpleForwardingClientCallListener<RespT>
- java.lang.Object
-
- io.grpc.ClientCall.Listener<RespT>
-
- io.grpc.ForwardingClientCallListener<RespT>
-
- io.grpc.ForwardingClientCallListener.SimpleForwardingClientCallListener<RespT>
-
- Enclosing class:
- ForwardingClientCallListener<RespT>
public abstract static class ForwardingClientCallListener.SimpleForwardingClientCallListener<RespT> extends ForwardingClientCallListener<RespT>
A simplified version ofForwardingClientCallListener
where subclasses can pass in aClientCall.Listener
as the delegate.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class io.grpc.ForwardingClientCallListener
ForwardingClientCallListener.SimpleForwardingClientCallListener<RespT>
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
SimpleForwardingClientCallListener(ClientCall.Listener<RespT> delegate)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ClientCall.Listener<RespT>
delegate()
Returns the delegatedClientCall.Listener
.void
onClose(Status status, Metadata trailers)
The ClientCall has been closed.void
onHeaders(Metadata headers)
The response headers have been received.void
onReady()
This indicates that the ClientCall may now be capable of sending additional messages (viaClientCall.sendMessage(ReqT)
) without requiring excessive buffering internally.String
toString()
-
Methods inherited from class io.grpc.ForwardingClientCallListener
onMessage
-
-
-
-
Constructor Detail
-
SimpleForwardingClientCallListener
protected SimpleForwardingClientCallListener(ClientCall.Listener<RespT> delegate)
-
-
Method Detail
-
delegate
protected ClientCall.Listener<RespT> delegate()
Description copied from class:ForwardingClientCallListener
Returns the delegatedClientCall.Listener
.- Specified by:
delegate
in classForwardingClientCallListener<RespT>
-
onHeaders
public void onHeaders(Metadata headers)
Description copied from class:ClientCall.Listener
The response headers have been received. Headers always precede messages.Since
Metadata
is not thread-safe, the caller must not access (read or write)headers
after this point.- Overrides:
onHeaders
in classClientCall.Listener<RespT>
- Parameters:
headers
- containing metadata sent by the server at the start of the response.
-
onClose
public void onClose(Status status, Metadata trailers)
Description copied from class:ClientCall.Listener
The ClientCall has been closed. Any additional calls to theClientCall
will not be processed by the server. No further receiving will occur and no further notifications will be made.Since
Metadata
is not thread-safe, the caller must not access (read or write)trailers
after this point.If
status
returns false forStatus.isOk()
, then the call failed. An additional block of trailer metadata may be received at the end of the call from the server. An emptyMetadata
object is passed if no trailers are received.This method should not throw. If this method throws, there is no way to be notified of the exception. Implementations should therefore be careful of exceptions which can accidentally leak resources.
- Overrides:
onClose
in classClientCall.Listener<RespT>
- Parameters:
status
- the result of the remote call.trailers
- metadata provided at call completion.
-
onReady
public void onReady()
Description copied from class:ClientCall.Listener
This indicates that the ClientCall may now be capable of sending additional messages (viaClientCall.sendMessage(ReqT)
) 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.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 checkingisReady()
's current value instead of assuming it is nowtrue
. IfisReady() == false
the normal expectations apply, so there would be anotheronReady()
callback.If the type of a call is either
MethodDescriptor.MethodType.UNARY
orMethodDescriptor.MethodType.SERVER_STREAMING
, this callback may not be fired. Calls that send exactly one message should not await this callback.- Overrides:
onReady
in classClientCall.Listener<RespT>
-
-