io.grpc

Class ManagedChannel

java.lang.Object

io.grpc.Channel

io.grpc.ManagedChannel

@ThreadSafe
public abstract class ManagedChannel
extends Channel

A Channel that provides lifecycle management.

Constructor Summary

Constructors

Constructor and Description
ManagedChannel()

Method Summary

Modifier and Type	Method and Description
abstract boolean	awaitTermination(long timeout, TimeUnit unit) Waits for the channel to become terminated, giving up if the timeout is reached.
ConnectivityState	getState(boolean requestConnection) Gets the current connectivity state.
abstract boolean	isShutdown() Returns whether the channel is shutdown.
abstract boolean	isTerminated() Returns whether the channel is terminated.
void	notifyWhenStateChanged(ConnectivityState source, Runnable callback) Registers a one-off callback that will be run if the connectivity state of the channel diverges from the given source, which is typically what has just been returned by getState(boolean).
abstract ManagedChannel	shutdown() Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.
abstract ManagedChannel	shutdownNow() Initiates a forceful shutdown in which preexisting and new calls are cancelled.

Methods inherited from class io.grpc.Channel

authority, newCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManagedChannel

public ManagedChannel()

Method Detail

shutdown

public abstract ManagedChannel shutdown()

Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.

Returns:

this

Since:

1.0.0

isShutdown

public abstract boolean isShutdown()

Returns whether the channel is shutdown. Shutdown channels immediately cancel any new calls, but may still have some calls being processed.

Since:

1.0.0

See Also:

shutdown(), isTerminated()

isTerminated

public abstract boolean isTerminated()

Returns whether the channel is terminated. Terminated channels have no running calls and relevant resources released (like TCP connections).

Since:

1.0.0

See Also:

isShutdown()

shutdownNow

public abstract ManagedChannel shutdownNow()

Initiates a forceful shutdown in which preexisting and new calls are cancelled. Although forceful, the shutdown process is still not instantaneous; isTerminated() will likely return false immediately after this method returns.

Returns:

this

Since:

1.0.0

awaitTermination

public abstract boolean awaitTermination(long timeout,
                                         TimeUnit unit)
                                  throws InterruptedException

Waits for the channel to become terminated, giving up if the timeout is reached.

Returns:

whether the channel is terminated, as would be done by isTerminated().

Throws:

InterruptedException

Since:

1.0.0

getState

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/28")
public ConnectivityState getState(boolean requestConnection)

Gets the current connectivity state. Note the result may soon become outdated.

Warning: this API is not yet implemented by the gRPC library (issue on github).

Parameters:

requestConnection - if true, the channel will try to make a connection if it is currently IDLE

Throws:

UnsupportedOperationException - if not supported by implementation

Since:

1.1.0

notifyWhenStateChanged

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/28")
public void notifyWhenStateChanged(ConnectivityState source,
                                                                                                         Runnable callback)

Registers a one-off callback that will be run if the connectivity state of the channel diverges from the given source, which is typically what has just been returned by getState(boolean). If the states are already different, the callback will be called immediately. The callback is run in the same executor that runs Call listeners.

Warning: this API is not yet implemented by the gRPC library (issue on github).

Parameters:

source - the assumed current state, typically just returned by getState(boolean)

callback - the one-off callback

Throws:

UnsupportedOperationException - if not supported by implementation

Since:

1.1.0