Package io.grpc.stub

Class AbstractFutureStub<S extends AbstractFutureStub<S>>

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<S>

Direct Known Subclasses:

ChannelzGrpc.ChannelzFutureStub, HealthGrpc.HealthFutureStub, LoadBalancerGrpc.LoadBalancerFutureStub, ServerReflectionGrpc.ServerReflectionFutureStub, ServerReflectionGrpc.ServerReflectionFutureStub

@ThreadSafe
@CheckReturnValue
public abstract class AbstractFutureStub<S extends AbstractFutureStub<S>>
extends AbstractStub<S>

Stub implementations for future stubs.

DO NOT MOCK: Customizing options doesn't work properly in mocks. Use InProcessChannelBuilder to create a real channel suitable for testing. It is also possible to mock Channel instead.

Since:

1.26.0

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

AbstractStub.StubFactory<T extends AbstractStub<T>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFutureStub(Channel channel, CallOptions callOptions)

Method Summary

Modifier and Type	Method	Description
static <T extends AbstractStub<T>> T	newStub(AbstractStub.StubFactory<T> factory, Channel channel)	Returns a new future stub with the given channel for the provided method configurations.
static <T extends AbstractStub<T>> T	newStub(AbstractStub.StubFactory<T> factory, Channel channel, CallOptions callOptions)	Returns a new future stub with the given channel for the provided method configurations.

Methods inherited from class io.grpc.stub.AbstractStub

build, getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFutureStub

protected AbstractFutureStub(Channel channel,
                             CallOptions callOptions)

Method Detail

newStub

public static <T extends AbstractStub<T>> T newStub(AbstractStub.StubFactory<T> factory,
                                                    Channel channel)

Returns a new future stub with the given channel for the provided method configurations.

Parameters:

factory - the factory to create a future stub

channel - the channel that this stub will use to do communications

Since:

1.26.0

newStub

public static <T extends AbstractStub<T>> T newStub(AbstractStub.StubFactory<T> factory,
                                                    Channel channel,
                                                    CallOptions callOptions)

Returns a new future stub with the given channel for the provided method configurations.

Parameters:

factory - the factory to create a future stub

channel - the channel that this stub will use to do communications

callOptions - the runtime call options to be applied to every call on this stub

Returns:

a future stub

Since:

1.26.0