io.grpc

Class ManagedChannel

java.lang.Object

io.grpc.Channel

io.grpc.ManagedChannel

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.
abstract boolean	isShutdown() Returns whether the channel is shutdown.
abstract boolean	isTerminated() Returns whether the channel is terminated.
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.

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.

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).

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.

NOT YET IMPLEMENTED. This method currently behaves identically to shutdown().

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