Class GrpcTransportChannel (2.24.0)

public abstract class GrpcTransportChannel implements TransportChannel

Implementation of TransportChannel based on gRPC.

Inheritance

java.lang.Object > GrpcTransportChannel

Implements

TransportChannel

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(ManagedChannel channel)

public static GrpcTransportChannel create(ManagedChannel channel)

Parameter
Name	Description
`channel`	`io.grpc.ManagedChannel`

Returns
Type	Description
`GrpcTransportChannel`

getGrpcTransportName()

public static String getGrpcTransportName()

The name of the Grpc transport.

Returns
Type	Description
`String`

newBuilder()

public static GrpcTransportChannel.Builder newBuilder()

Returns
Type	Description
`GrpcTransportChannel.Builder`

Constructors

GrpcTransportChannel()

public GrpcTransportChannel()

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Blocks until all work has completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public void close()

getChannel()

public Channel getChannel()

Returns
Type	Description
`io.grpc.Channel`

getEmptyCallContext()

public GrpcCallContext getEmptyCallContext()

Returns an empty ApiCallContext that is compatible with this TransportChannel.

Returns
Type	Description
`GrpcCallContext`

getTransportName()

public String getTransportName()

The name of the transport.

This string can be used for identifying transports for switching logic.

Returns
Type	Description
`String`

isShutdown()

public boolean isShutdown()

Returns true if this background resource has been shut down.

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns true if all work has completed following shut down. Note that isTerminated is never true unless either shutdown or shutdownNow was called first.

Returns
Type	Description
`boolean`

shutdown()

public void shutdown()

Initiates an orderly shutdown in which previously submitted work is finished, but no new work will be accepted. Invocation has no additional effect if already shut down.

This method does not wait for previously submitted work to complete execution. Use awaitTermination to do that.

shutdownNow()

public void shutdownNow()

Attempts to stop all actively executing work and halts the processing of waiting work.

This method does not wait for actively executing work to terminate. Use awaitTermination to do that.

There are no guarantees beyond best-effort attempts to stop processing actively executing work. For example, typical implementations will cancel via Thread.interrupt(), so any task that fails to respond to interrupts may never terminate.