Class DelayedClientCall<ReqT,RespT>
- Direct Known Subclasses:
ManagedChannelImpl.RealChannel.PendingCall
ClientCall
itself doesn't require thread-safety. However, the state of
DelayedCall
may be internally altered by different threads, thus internal synchronization is
necessary.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate final class
private static final class
Nested classes/interfaces inherited from class io.grpc.ClientCall
ClientCall.Listener<T>
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Executor
private final Context
private DelayedClientCall.DelayedListener
<RespT> private Status
private final ScheduledFuture
<?> A timer to monitor the initial deadline.private ClientCall.Listener
<RespT> Non-null
iff start has been called.private static final Logger
private static final ClientCall
<Object, Object> private boolean
true
once realCall is valid and all pending calls have been drained.private ClientCall
<ReqT, RespT> -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
DelayedClientCall
(Executor callExecutor, ScheduledExecutorService scheduler, Deadline deadline) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
private void
Cancels the call unlessrealCall
is set andonlyCancelPendingCall
is true.final void
Prevent any further processing for thisClientCall
.private void
delayOrExecute
(Runnable runnable) private void
Called to transitionpassThrough
totrue
.final Attributes
Returns additional properties of the call.(package private) final ClientCall
<ReqT, RespT> final void
Close the call for request message sending.private boolean
isAbeforeB
(Deadline a, Deadline b) final boolean
isReady()
Iftrue
, indicates that the call is capable of sending additional messages without requiring excessive buffering internally.final void
request
(int numMessages) Requests up to the given number of messages from the call to be delivered toClientCall.Listener.onMessage(Object)
.private ScheduledFuture
<?> scheduleDeadlineIfNeeded
(ScheduledExecutorService scheduler, Deadline deadline) final void
sendMessage
(ReqT message) Send a request message to the server.final Runnable
setCall
(ClientCall<ReqT, RespT> call) Transfers all pending and future requests and mutations to the given call.final void
setMessageCompression
(boolean enable) Enables per-message compression, if an encoding type has been negotiated.private void
setRealCall
(ClientCall<ReqT, RespT> realCall) final void
start
(ClientCall.Listener<RespT> listener, Metadata headers) Start a call, usingresponseListener
for processing response messages.toString()
-
Field Details
-
logger
-
initialDeadlineMonitor
A timer to monitor the initial deadline. The timer must be cancelled on transition to the real call. -
callExecutor
-
context
-
passThrough
private volatile boolean passThroughtrue
once realCall is valid and all pending calls have been drained. -
listener
Non-null
iff start has been called. Used to assert methods are called in appropriate order, but also used if an error occurs beforerealCall
is set. -
realCall
-
error
-
pendingRunnables
-
delayedListener
-
NOOP_CALL
-
-
Constructor Details
-
DelayedClientCall
protected DelayedClientCall(Executor callExecutor, ScheduledExecutorService scheduler, @Nullable Deadline deadline)
-
-
Method Details
-
isAbeforeB
-
scheduleDeadlineIfNeeded
@Nullable private ScheduledFuture<?> scheduleDeadlineIfNeeded(ScheduledExecutorService scheduler, @Nullable Deadline deadline) -
setCall
Transfers all pending and future requests and mutations to the given call.No-op if either this method or
cancel(java.lang.String, java.lang.Throwable)
have already been called. -
start
Description copied from class:ClientCall
Start a call, usingresponseListener
for processing response messages.It must be called prior to any other method on this class, except for
ClientCall.cancel(java.lang.String, java.lang.Throwable)
which may be called at any time.Since
Metadata
is not thread-safe, the caller must not access (read or write)headers
after this point.- Specified by:
start
in classClientCall<ReqT,
RespT> - Parameters:
listener
- receives response messagesheaders
- which can contain extra call metadata, e.g. authentication credentials.
-
cancel
Description copied from class:ClientCall
Prevent any further processing for thisClientCall
. No further messages may be sent or will be received. The server is informed of cancellations, but may not stop processing the call. Cancellation is permitted even if previouslyClientCall.halfClose()
d. Cancelling an alreadycancel()
edClientCall
has no effect.No other methods on this class can be called after this method has been called.
It is recommended that at least one of the arguments to be non-
null
, to provide useful debug information. Both argument being null may log warnings and result in suboptimal performance. Also note that the provided information will not be sent to the server.- Specified by:
cancel
in classClientCall<ReqT,
RespT> - Parameters:
message
- if notnull
, will appear as the description of the CANCELLED statuscause
- if notnull
, will appear as the cause of the CANCELLED status
-
cancel
Cancels the call unlessrealCall
is set andonlyCancelPendingCall
is true. -
callCancelled
protected void callCancelled() -
delayOrExecute
-
drainPendingCalls
private void drainPendingCalls()Called to transitionpassThrough
totrue
. This method is not safe to be called multiple times; the caller must ensure it will only be called once, ever.this
lock should not be held when calling this method. -
setRealCall
-
getRealCall
-
sendMessage
Description copied from class:ClientCall
Send a request message to the server. May be called zero or more times depending on how many messages the server is willing to accept for the operation.- Specified by:
sendMessage
in classClientCall<ReqT,
RespT> - Parameters:
message
- message to be sent to the server.
-
setMessageCompression
public final void setMessageCompression(boolean enable) Description copied from class:ClientCall
Enables per-message compression, if an encoding type has been negotiated. If no message encoding has been negotiated, this is a no-op. By default per-message compression is enabled, but may not have any effect if compression is not enabled on the call.- Overrides:
setMessageCompression
in classClientCall<ReqT,
RespT>
-
request
public final void request(int numMessages) Description copied from class:ClientCall
Requests up to the given number of messages from the call to be delivered toClientCall.Listener.onMessage(Object)
. No additional messages will be delivered.Message delivery is guaranteed to be sequential in the order received. In addition, the listener methods will not be accessed concurrently. While it is not guaranteed that the same thread will always be used, it is guaranteed that only a single thread will access the listener at a time.
If it is desired to bypass inbound flow control, a very large number of messages can be specified (e.g.
Integer.MAX_VALUE
).If called multiple times, the number of messages able to delivered will be the sum of the calls.
This method is safe to call from multiple threads without external synchronization.
- Specified by:
request
in classClientCall<ReqT,
RespT> - Parameters:
numMessages
- the requested number of messages to be delivered to the listener. Must be non-negative.
-
halfClose
public final void halfClose()Description copied from class:ClientCall
Close the call for request message sending. Incoming response messages are unaffected. This should be called when no more messages will be sent from the client.- Specified by:
halfClose
in classClientCall<ReqT,
RespT>
-
isReady
public final boolean isReady()Description copied from class:ClientCall
Iftrue
, indicates that the call is capable of sending additional messages 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.If
false
,ClientCall.Listener.onReady()
will be called afterisReady()
transitions totrue
.If the type of the call is either
MethodDescriptor.MethodType.UNARY
orMethodDescriptor.MethodType.SERVER_STREAMING
, this method may persistently return false. Calls that send exactly one message should not check this method.This abstract class's implementation always returns
true
. Implementations generally override the method.- Overrides:
isReady
in classClientCall<ReqT,
RespT>
-
getAttributes
Description copied from class:ClientCall
Returns additional properties of the call. May only be called afterClientCall.Listener.onHeaders(io.grpc.Metadata)
orClientCall.Listener.onClose(io.grpc.Status, io.grpc.Metadata)
. If called prematurely, the implementation may throwIllegalStateException
or return arbitraryAttributes
.- Overrides:
getAttributes
in classClientCall<ReqT,
RespT> - Returns:
- non-
null
attributes
-
toString
-