io.grpc.stub

Class AbstractStub<S extends AbstractStub<S>>

java.lang.Object

io.grpc.stub.AbstractStub<S>

Type Parameters:

S - the concrete type of this stub.

public abstract class AbstractStub<S extends AbstractStub<S>>
extends Object

Common base type for stub implementations.

This is the base class of the stub classes from the generated code. It allows for reconfiguration, e.g., attaching interceptors to the stub.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStub(io.grpc.Channel channel) Constructor for use by subclasses, with the default CallOptions.
protected	AbstractStub(io.grpc.Channel channel, io.grpc.CallOptions callOptions) Constructor for use by subclasses, with the default CallOptions.

Method Summary

Modifier and Type	Method and Description
protected abstract S	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions) Returns a new stub with the given channel for the provided method configurations.
io.grpc.CallOptions	getCallOptions() The CallOptions of the stub.
io.grpc.Channel	getChannel() The underlying channel of the stub.
S	withCallCredentials(io.grpc.CallCredentials credentials) Returns a new stub that uses the given call credentials.
S	withChannel(io.grpc.Channel newChannel) Returns a new stub that uses the given channel.
S	withCompression(String compressorName) Set's the compressor name to use for the call.
S	withDeadline(io.grpc.Deadline deadline) Returns a new stub with an absolute deadline.
S	withDeadlineAfter(long duration, TimeUnit unit) Returns a new stub with a deadline that is after the given duration from now.
S	withDeadlineNanoTime(Long deadlineNanoTime) Deprecated. Use withDeadline(Deadline) instead.
S	withInterceptors(io.grpc.ClientInterceptor... interceptors) Returns a new stub that has the given interceptors attached to the underlying channel.
<T> S	withOption(io.grpc.CallOptions.Key<T> key, T value) Sets a custom option to be passed to client interceptors on the channel ClientInterceptor via the CallOptions parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStub

protected AbstractStub(io.grpc.Channel channel)

Constructor for use by subclasses, with the default CallOptions.

Parameters:

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

AbstractStub

protected AbstractStub(io.grpc.Channel channel,
                       io.grpc.CallOptions callOptions)

Constructor for use by subclasses, with the default CallOptions.

Parameters:

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

Method Detail

getChannel

public final io.grpc.Channel getChannel()

The underlying channel of the stub.

getCallOptions

public final io.grpc.CallOptions getCallOptions()

The CallOptions of the stub.

build

protected abstract S build(io.grpc.Channel channel,
                           io.grpc.CallOptions callOptions)

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

Parameters:

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

withDeadline

public final S withDeadline(@Nullable
                            io.grpc.Deadline deadline)

Returns a new stub with an absolute deadline.

This is mostly used for propagating an existing deadline. withDeadlineAfter(long, java.util.concurrent.TimeUnit) is the recommended way of setting a new deadline,

Parameters:

deadline - the deadline or null for unsetting the deadline.

withDeadlineNanoTime

@Deprecated
public final S withDeadlineNanoTime(@Nullable
                                                Long deadlineNanoTime)

Deprecated. Use withDeadline(Deadline) instead.

Returns a new stub with an absolute deadline in nanoseconds in the clock as per System.nanoTime().

This is mostly used for propagating an existing deadline. withDeadlineAfter(long, java.util.concurrent.TimeUnit) is the recommended way of setting a new deadline,

Parameters:

deadlineNanoTime - nanoseconds in the clock as per System.nanoTime()

withDeadlineAfter

public final S withDeadlineAfter(long duration,
                                 TimeUnit unit)

Returns a new stub with a deadline that is after the given duration from now.

See Also:

CallOptions.withDeadlineAfter(long, java.util.concurrent.TimeUnit)

withCompression

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1704")
public final S withCompression(String compressorName)

Set's the compressor name to use for the call. It is the responsibility of the application to make sure the server supports decoding the compressor picked by the client. To be clear, this is the compressor used by the stub to compress messages to the server. To get compressed responses from the server, set the appropriate DecompressorRegistry on the ManagedChannelBuilder.

Parameters:

compressorName - the name (e.g. "gzip") of the compressor to use.

withChannel

public final S withChannel(io.grpc.Channel newChannel)

Returns a new stub that uses the given channel.

withOption

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1869")
public final <T> S withOption(io.grpc.CallOptions.Key<T> key,
                                                                                                      T value)

Sets a custom option to be passed to client interceptors on the channel ClientInterceptor via the CallOptions parameter.

Parameters:

key - the option being set

value - the value for the key

withInterceptors

public final S withInterceptors(io.grpc.ClientInterceptor... interceptors)

Returns a new stub that has the given interceptors attached to the underlying channel.

withCallCredentials

@ExperimentalApi(value="https//github.com/grpc/grpc-java/issues/1914")
public final S withCallCredentials(io.grpc.CallCredentials credentials)

Returns a new stub that uses the given call credentials.