Package io.grpc.stub
Class ServerCalls.UnaryServerCallHandler.UnaryServerCallListener
- java.lang.Object
-
- io.grpc.ServerCall.Listener<ReqT>
-
- io.grpc.stub.ServerCalls.UnaryServerCallHandler.UnaryServerCallListener
-
- Enclosing class:
- ServerCalls.UnaryServerCallHandler<ReqT,RespT>
private final class ServerCalls.UnaryServerCallHandler.UnaryServerCallListener extends ServerCall.Listener<ReqT>
-
-
Field Summary
Fields Modifier and Type Field Description private ServerCall<ReqT,RespT>callprivate booleancanInvokeprivate ReqTrequestprivate ServerCalls.ServerCallStreamObserverImpl<ReqT,RespT>responseObserverprivate booleanwasReady
-
Constructor Summary
Constructors Constructor Description UnaryServerCallListener(ServerCalls.ServerCallStreamObserverImpl<ReqT,RespT> responseObserver, ServerCall<ReqT,RespT> call)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidonCancel()The call was cancelled and the server is encouraged to abort processing to save resources, since the client will not process any further messages.voidonComplete()The call is considered complete andServerCall.Listener.onCancel()is guaranteed not to be called.voidonHalfClose()The client completed all message sending.voidonMessage(ReqT request)A request message has been received.voidonReady()This indicates that the call may now be capable of sending additional messages (viaServerCall.sendMessage(RespT)) without requiring excessive buffering internally.
-
-
-
Field Detail
-
call
private final ServerCall<ReqT,RespT> call
-
responseObserver
private final ServerCalls.ServerCallStreamObserverImpl<ReqT,RespT> responseObserver
-
canInvoke
private boolean canInvoke
-
wasReady
private boolean wasReady
-
request
private ReqT request
-
-
Constructor Detail
-
UnaryServerCallListener
UnaryServerCallListener(ServerCalls.ServerCallStreamObserverImpl<ReqT,RespT> responseObserver, ServerCall<ReqT,RespT> call)
-
-
Method Detail
-
onMessage
public void onMessage(ReqT request)
Description copied from class:ServerCall.ListenerA request message has been received. For streaming calls, there may be zero or more request messages.- Overrides:
onMessagein classServerCall.Listener<ReqT>- Parameters:
request- a received request message.
-
onHalfClose
public void onHalfClose()
Description copied from class:ServerCall.ListenerThe client completed all message sending. However, the call may still be cancelled.- Overrides:
onHalfClosein classServerCall.Listener<ReqT>
-
onCancel
public void onCancel()
Description copied from class:ServerCall.ListenerThe 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.
- Overrides:
onCancelin classServerCall.Listener<ReqT>
-
onReady
public void onReady()
Description copied from class:ServerCall.ListenerThis indicates that the call may now be capable of sending additional messages (viaServerCall.sendMessage(RespT)) 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() == falsewithin this callback. Handle "spurious" notifications by checkingisReady()'s current value instead of assuming it is nowtrue. IfisReady() == falsethe normal expectations apply, so there would be anotheronReady()callback.- Overrides:
onReadyin classServerCall.Listener<ReqT>
-
onComplete
public void onComplete()
Description copied from class:ServerCall.ListenerThe call is considered complete andServerCall.Listener.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.
- Overrides:
onCompletein classServerCall.Listener<ReqT>
-
-