io.grpc

Class CallOptions

java.lang.Object

io.grpc.CallOptions

@Immutable
public final class CallOptions
extends Object

The collection of runtime options for a new RPC call.

A field that is not set is null.

Field Summary

Fields

Modifier and Type	Field and Description
static CallOptions	DEFAULT A blank CallOptions that all fields are not set.

Method Summary

Modifier and Type	Method and Description
Attributes	getAffinity() Returns the attributes for affinity-based routing.
String	getAuthority() Override the HTTP/2 authority the channel claims to be connecting to.
String	getCompressor() Returns the compressor's name.
Deadline	getDeadline() Returns the deadline or null if the deadline is not set.
Long	getDeadlineNanoTime() Deprecated. Use getDeadline() instead.
Executor	getExecutor()
String	toString()
CallOptions	withAffinity(Attributes affinity) Returns a new CallOptions with attributes for affinity-based routing.
CallOptions	withAuthority(String authority) Override the HTTP/2 authority the channel claims to be connecting to.
CallOptions	withCompression(String compressorName) Sets the compression to use for the call.
CallOptions	withDeadline(Deadline deadline) Returns a new CallOptions with the given absolute deadline.
CallOptions	withDeadlineAfter(long duration, TimeUnit unit) Returns a new CallOptions with a deadline that is after the given duration from now.
CallOptions	withDeadlineNanoTime(Long deadlineNanoTime) Deprecated. Use withDeadline(Deadline) instead.
CallOptions	withExecutor(Executor executor) Returns a new CallOptions with executor to be used instead of the default executor specified with ManagedChannelBuilder.executor(java.util.concurrent.Executor).

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final CallOptions DEFAULT

A blank CallOptions that all fields are not set.

Method Detail

withAuthority

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/67")
public CallOptions withAuthority(@Nullable
                                                                                                       String authority)

Override the HTTP/2 authority the channel claims to be connecting to. This is not generally safe. Overriding allows advanced users to re-use a single Channel for multiple services, even if those services are hosted on different domain names. That assumes the server is virtually hosting multiple domains and is guaranteed to continue doing so. It is rare for a service provider to make such a guarantee. At this time, there is no security verification of the overridden value, such as making sure the authority matches the server's TLS certificate.

withCompression

@ExperimentalApi
public CallOptions withCompression(@Nullable
                                                    String compressorName)

Sets the compression to use for the call. The compressor must be a valid name known in the CompressorRegistry.

withDeadline

@ExperimentalApi
public CallOptions withDeadline(@Nullable
                                                 Deadline deadline)

Returns a new CallOptions with the given 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 CallOptions withDeadlineNanoTime(@Nullable
                                                    Long deadlineNanoTime)

Deprecated. Use withDeadline(Deadline) instead.

Returns a new CallOptions with the given 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 - the deadline in the clock as per System.nanoTime(). null for unsetting the deadline.

withDeadlineAfter

public CallOptions withDeadlineAfter(long duration,
                                     TimeUnit unit)

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

getDeadlineNanoTime

@Deprecated
public Long getDeadlineNanoTime()

Deprecated. Use getDeadline() instead.

Returns the deadline in nanoseconds in the clock as per System.nanoTime(). null if the deadline is not set.

getDeadline

@ExperimentalApi
 @Nullable
public Deadline getDeadline()

Returns the deadline or null if the deadline is not set.

withAffinity

@ExperimentalApi
public CallOptions withAffinity(Attributes affinity)

Returns a new CallOptions with attributes for affinity-based routing.

getAffinity

@ExperimentalApi
public Attributes getAffinity()

Returns the attributes for affinity-based routing.

getCompressor

@ExperimentalApi
 @Nullable
public String getCompressor()

Returns the compressor's name.

getAuthority

@Nullable
 @ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/67")
public String getAuthority()

Override the HTTP/2 authority the channel claims to be connecting to. This is not generally safe. Overriding allows advanced users to re-use a single Channel for multiple services, even if those services are hosted on different domain names. That assumes the server is virtually hosting multiple domains and is guaranteed to continue doing so. It is rare for a service provider to make such a guarantee. At this time, there is no security verification of the overridden value, such as making sure the authority matches the server's TLS certificate.

withExecutor

public CallOptions withExecutor(Executor executor)

Returns a new CallOptions with executor to be used instead of the default executor specified with ManagedChannelBuilder.executor(java.util.concurrent.Executor).

getExecutor

@Nullable
public Executor getExecutor()

toString

public String toString()

Overrides:

toString in class Object