Package io.grpc.internal
Class OobChannel
java.lang.Object
io.grpc.Channel
io.grpc.ManagedChannel
io.grpc.internal.OobChannel
- All Implemented Interfaces:
InternalInstrumented<InternalChannelz.ChannelStats>
,InternalWithLogId
@ThreadSafe
final class OobChannel
extends ManagedChannel
implements InternalInstrumented<InternalChannelz.ChannelStats>
A ManagedChannel backed by a single
InternalSubchannel
and used for LoadBalancer
to its own RPC needs.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final String
private final CallTracer
private final ChannelTracer
private final InternalChannelz
private final ScheduledExecutorService
private final DelayedClientTransport
private final Executor
private final ObjectPool
<? extends Executor> private static final Logger
private final InternalLogId
private boolean
private InternalSubchannel
private AbstractSubchannel
private LoadBalancer.SubchannelPicker
private final CountDownLatch
private final TimeProvider
private final ClientCallImpl.ClientStreamProvider
-
Constructor Summary
ConstructorsConstructorDescriptionOobChannel
(String authority, ObjectPool<? extends Executor> executorPool, ScheduledExecutorService deadlineCancellationExecutor, SynchronizationContext syncContext, CallTracer callsTracer, ChannelTracer channelTracer, InternalChannelz channelz, TimeProvider timeProvider) -
Method Summary
Modifier and TypeMethodDescriptionThe authority of the destination this channel connects to.boolean
awaitTermination
(long time, TimeUnit unit) Waits for the channel to become terminated, giving up if the timeout is reached.(package private) InternalSubchannel
getLogId()
Returns an ID that is primarily used in debug logs.getState
(boolean requestConnectionIgnored) Gets the current connectivity state.com.google.common.util.concurrent.ListenableFuture
<InternalChannelz.ChannelStats> getStats()
Returns the stats object.(package private) LoadBalancer.Subchannel
(package private) void
(package private) void
boolean
Returns whether the channel is shutdown.boolean
Returns whether the channel is terminated.<RequestT,
ResponseT>
ClientCall<RequestT, ResponseT> newCall
(MethodDescriptor<RequestT, ResponseT> methodDescriptor, CallOptions callOptions) Create aClientCall
to the remote operation specified by the givenMethodDescriptor
.void
For subchannels that are in TRANSIENT_FAILURE state, short-circuit the backoff timer and make them reconnect immediately.(package private) void
setSubchannel
(InternalSubchannel subchannel) shutdown()
Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.Initiates a forceful shutdown in which preexisting and new calls are cancelled.toString()
(package private) void
Methods inherited from class io.grpc.ManagedChannel
enterIdle, notifyWhenStateChanged
-
Field Details
-
log
-
subchannel
-
subchannelImpl
-
subchannelPicker
-
logId
-
authority
-
delayedTransport
-
channelz
-
executorPool
-
executor
-
deadlineCancellationExecutor
-
terminatedLatch
-
shutdown
private volatile boolean shutdown -
channelCallsTracer
-
channelTracer
-
timeProvider
-
transportProvider
-
-
Constructor Details
-
OobChannel
OobChannel(String authority, ObjectPool<? extends Executor> executorPool, ScheduledExecutorService deadlineCancellationExecutor, SynchronizationContext syncContext, CallTracer callsTracer, ChannelTracer channelTracer, InternalChannelz channelz, TimeProvider timeProvider)
-
-
Method Details
-
setSubchannel
-
updateAddresses
-
newCall
public <RequestT,ResponseT> ClientCall<RequestT,ResponseT> newCall(MethodDescriptor<RequestT, ResponseT> methodDescriptor, CallOptions callOptions) Description copied from class:Channel
Create aClientCall
to the remote operation specified by the givenMethodDescriptor
. The returnedClientCall
does not trigger any remote behavior untilClientCall.start(ClientCall.Listener, Metadata)
is invoked.- Specified by:
newCall
in classChannel
- Parameters:
methodDescriptor
- describes the name and parameter types of the operation to call.callOptions
- runtime options to be applied to this call.- Returns:
- a
ClientCall
bound to the specified method.
-
authority
Description copied from class:Channel
The authority of the destination this channel connects to. Typically this is in the formathost:port
. -
isTerminated
public boolean isTerminated()Description copied from class:ManagedChannel
Returns whether the channel is terminated. Terminated channels have no running calls and relevant resources released (like TCP connections).- Specified by:
isTerminated
in classManagedChannel
- See Also:
-
awaitTermination
Description copied from class:ManagedChannel
Waits for the channel to become terminated, giving up if the timeout is reached.- Specified by:
awaitTermination
in classManagedChannel
- Returns:
- whether the channel is terminated, as would be done by
ManagedChannel.isTerminated()
. - Throws:
InterruptedException
-
getState
Description copied from class:ManagedChannel
Gets the current connectivity state. Note the result may soon become outdated.Note that the core library did not provide an implementation of this method until v1.6.1.
- Overrides:
getState
in classManagedChannel
- Parameters:
requestConnectionIgnored
- iftrue
, the channel will try to make a connection if it is currently IDLE
-
shutdown
Description copied from class:ManagedChannel
Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.- Specified by:
shutdown
in classManagedChannel
- Returns:
- this
-
isShutdown
public boolean isShutdown()Description copied from class:ManagedChannel
Returns whether the channel is shutdown. Shutdown channels immediately cancel any new calls, but may still have some calls being processed.- Specified by:
isShutdown
in classManagedChannel
- See Also:
-
shutdownNow
Description copied from class:ManagedChannel
Initiates a forceful shutdown in which preexisting and new calls are cancelled. Although forceful, the shutdown process is still not instantaneous;ManagedChannel.isTerminated()
will likely returnfalse
immediately after this method returns.- Specified by:
shutdownNow
in classManagedChannel
- Returns:
- this
-
handleSubchannelStateChange
-
handleSubchannelTerminated
void handleSubchannelTerminated() -
getSubchannel
LoadBalancer.Subchannel getSubchannel() -
getInternalSubchannel
InternalSubchannel getInternalSubchannel() -
getStats
Description copied from interface:InternalInstrumented
Returns the stats object.- Specified by:
getStats
in interfaceInternalInstrumented<InternalChannelz.ChannelStats>
-
getLogId
Description copied from interface:InternalWithLogId
Returns an ID that is primarily used in debug logs. It usually contains the class name and a numeric ID that is unique among the instances.The subclasses of this interface usually want to include the log ID in their
Object.toString()
results.- Specified by:
getLogId
in interfaceInternalWithLogId
-
toString
-
resetConnectBackoff
public void resetConnectBackoff()Description copied from class:ManagedChannel
For subchannels that are in TRANSIENT_FAILURE state, short-circuit the backoff timer and make them reconnect immediately. May also attempt to invokeNameResolver.refresh()
.This is primarily intended for Android users, where the network may experience frequent temporary drops. Rather than waiting for gRPC's name resolution and reconnect timers to elapse before reconnecting, the app may use this method as a mechanism to notify gRPC that the network is now available and a reconnection attempt may occur immediately.
No-op if not supported by the implementation.
- Overrides:
resetConnectBackoff
in classManagedChannel
-