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
String	getAuthority() Override the HTTP/2 authority the channel claims to be connecting to.
Long	getDeadlineNanoTime() Returns the deadline in nanoseconds in the clock as per System.nanoTime().
RequestKey	getRequestKey() Returns the request key for affinity-based routing.
String	toString()
CallOptions	withAuthority(String authority) Override the HTTP/2 authority the channel claims to be connecting to.
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) Returns a new CallOptions with the given absolute deadline in nanoseconds in the clock as per System.nanoTime().
CallOptions	withRequestKey(RequestKey requestKey) Returns a new CallOptions with a request key for affinity-based routing.

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.

withDeadlineNanoTime

public CallOptions withDeadlineNanoTime(@Nullable
                                        Long deadlineNanoTime)

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

@Nullable
public Long getDeadlineNanoTime()

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

withRequestKey

@ExperimentalApi
public CallOptions withRequestKey(@Nullable
                                                   RequestKey requestKey)

Returns a new CallOptions with a request key for affinity-based routing.

getRequestKey

@ExperimentalApi
 @Nullable
public RequestKey getRequestKey()

Returns the request key for affinity-based routing.

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.

toString

public String toString()

Overrides:

toString in class Object