io.grpc

Class ChannelImpl

java.lang.Object

io.grpc.Channel

io.grpc.ChannelImpl

@ThreadSafe
public final class ChannelImpl
extends Channel

A communication channel for making outgoing RPCs.

Constructor Summary

Constructors

Constructor and Description
ChannelImpl(ClientTransportFactory transportFactory, ExecutorService executor)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTerminated(long timeout, TimeUnit unit) Waits for the channel to become terminated, giving up if the timeout is reached.
boolean	isShutdown() Returns whether the channel is shutdown.
boolean	isTerminated() Returns whether the channel is terminated.
<ReqT,RespT> Call<ReqT,RespT>	newCall(MethodDescriptor<ReqT,RespT> method) Creates a new outgoing call on the channel.
ChannelImpl	shutdown() Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.
ChannelImpl	shutdownNow() Initiates a forceful shutdown in which preexisting and new calls are cancelled.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelImpl

public ChannelImpl(ClientTransportFactory transportFactory,
                   ExecutorService executor)

Method Detail

shutdown

public ChannelImpl shutdown()

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

shutdownNow

public ChannelImpl 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().

isShutdown

public 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()

awaitTerminated

public boolean awaitTerminated(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

isTerminated

public boolean isTerminated()

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

See Also:

isShutdown()

newCall

public <ReqT,RespT> Call<ReqT,RespT> newCall(MethodDescriptor<ReqT,RespT> method)

Creates a new outgoing call on the channel.

Specified by:

newCall in class Channel

Parameters:

method - describes the name and parameter types of the operation to call.

Returns:

a Call bound to the specified method.