Package io.grpc
Class CallOptions
- java.lang.Object
-
- io.grpc.CallOptions
-
@Immutable @CheckReturnValue public final class CallOptions extends Object
The collection of runtime options for a new RPC call.A field that is not set is
null
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CallOptions.Key<T>
Key for a key-value pair.
-
Field Summary
Fields Modifier and Type Field Description static CallOptions
DEFAULT
A blankCallOptions
that all fields are not set.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CallOptions
clearOnReadyThreshold()
Resets to the default number of bytes that must be queued before the call will leave the 'wait for ready' state.String
getAuthority()
Override the HTTP/2 authority the channel claims to be connecting to.String
getCompressor()
Returns the compressor's name.CallCredentials
getCredentials()
Returns the call credentials.Deadline
getDeadline()
Returns the deadline ornull
if the deadline is not set.Executor
getExecutor()
Returns the executor override to use for this specific call, ornull
if there is no override.Integer
getMaxInboundMessageSize()
Gets the maximum allowed message size acceptable from the remote peer.Integer
getMaxOutboundMessageSize()
Gets the maximum allowed message size acceptable to send the remote peer.Integer
getOnReadyThreshold()
Returns to the default number of bytes that must be queued before the call will leave the 'wait for ready' state.<T> T
getOption(CallOptions.Key<T> key)
Get the value for a custom option or its inherent default.List<ClientStreamTracer.Factory>
getStreamTracerFactories()
Returns an immutable list ofClientStreamTracerFactory
s.boolean
isWaitForReady()
Returns whether 'wait for ready' option is enabled for the call.String
toString()
CallOptions
withAuthority(String authority)
Override the HTTP/2 authority the channel claims to be connecting to.CallOptions
withCallCredentials(CallCredentials credentials)
Returns a newCallOptions
with the given call credentials.CallOptions
withCompression(String compressorName)
Sets the compression to use for the call.CallOptions
withDeadline(Deadline deadline)
Returns a newCallOptions
with the given absolute deadline.CallOptions
withDeadlineAfter(long duration, TimeUnit unit)
Returns a newCallOptions
with a deadline that is after the givenduration
from now.CallOptions
withDeadlineAfter(Duration duration)
CallOptions
withExecutor(Executor executor)
Returns a newCallOptions
withexecutor
to be used instead of the default executor specified withManagedChannelBuilder.executor(java.util.concurrent.Executor)
.CallOptions
withMaxInboundMessageSize(int maxSize)
Sets the maximum allowed message size acceptable from the remote peer.CallOptions
withMaxOutboundMessageSize(int maxSize)
Sets the maximum allowed message size acceptable sent to the remote peer.CallOptions
withOnReadyThreshold(int numBytes)
Specifies how many bytes must be queued before the call is considered not ready to send more messages.<T> CallOptions
withOption(CallOptions.Key<T> key, T value)
Sets a custom option.CallOptions
withoutWaitForReady()
Disables 'wait for ready' feature for the call.CallOptions
withStreamTracerFactory(ClientStreamTracer.Factory factory)
Returns a newCallOptions
with aClientStreamTracerFactory
in addition to the existing factories.CallOptions
withWaitForReady()
Enables 'wait for ready' for the call.
-
-
-
Field Detail
-
DEFAULT
public static final CallOptions DEFAULT
A blankCallOptions
that all fields are not set.
-
-
Method Detail
-
withAuthority
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1767") 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.
-
withCallCredentials
public CallOptions withCallCredentials(@Nullable CallCredentials credentials)
Returns a newCallOptions
with the given call credentials.
-
withCompression
public CallOptions withCompression(@Nullable String compressorName)
Sets the compression to use for the call. The compressor must be a valid name known in theCompressorRegistry
. By default, the "gzip" compressor will be available.It is only safe to call this if the server supports the compression format chosen. There is no negotiation performed; if the server does not support the compression chosen, the call will fail.
-
withDeadline
public CallOptions withDeadline(@Nullable Deadline deadline)
Returns a newCallOptions
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 ornull
for unsetting the deadline.
-
withDeadlineAfter
public CallOptions withDeadlineAfter(long duration, TimeUnit unit)
Returns a newCallOptions
with a deadline that is after the givenduration
from now.
-
withDeadlineAfter
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/11657") public CallOptions withDeadlineAfter(Duration duration)
-
getDeadline
@Nullable public Deadline getDeadline()
Returns the deadline ornull
if the deadline is not set.
-
withWaitForReady
public CallOptions withWaitForReady()
Enables 'wait for ready' for the call. Wait-for-ready queues the RPC until a connection is available. This may dramatically increase the latency of the RPC, but avoids failing "unnecessarily." The default queues the RPC until an attempt to connect has completed, but fails RPCs without sending them if unable to connect.
-
withoutWaitForReady
public CallOptions withoutWaitForReady()
Disables 'wait for ready' feature for the call. This method should be rarely used because the default is without 'wait for ready'.
-
withOnReadyThreshold
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/11021") public CallOptions withOnReadyThreshold(int numBytes)
Specifies how many bytes must be queued before the call is considered not ready to send more messages.- Parameters:
numBytes
- The number of bytes that must be queued. Must be a positive integer.
-
clearOnReadyThreshold
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/11021") public CallOptions clearOnReadyThreshold()
Resets to the default number of bytes that must be queued before the call will leave the 'wait for ready' state.
-
getOnReadyThreshold
@Nullable @ExperimentalApi("https://github.com/grpc/grpc-java/issues/11021") public Integer getOnReadyThreshold()
Returns to the default number of bytes that must be queued before the call will leave the 'wait for ready' state.- Returns:
- null if the default threshold is used.
-
getAuthority
@Nullable @ExperimentalApi("https://github.com/grpc/grpc-java/issues/1767") 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.
-
getCredentials
@Nullable public CallCredentials getCredentials()
Returns the call credentials.
-
withExecutor
public CallOptions withExecutor(@Nullable Executor executor)
Returns a newCallOptions
withexecutor
to be used instead of the default executor specified withManagedChannelBuilder.executor(java.util.concurrent.Executor)
.
-
withStreamTracerFactory
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/2861") public CallOptions withStreamTracerFactory(ClientStreamTracer.Factory factory)
Returns a newCallOptions
with aClientStreamTracerFactory
in addition to the existing factories.This method doesn't replace existing factories, or try to de-duplicate factories.
-
getStreamTracerFactories
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/2861") public List<ClientStreamTracer.Factory> getStreamTracerFactories()
Returns an immutable list ofClientStreamTracerFactory
s.
-
withOption
public <T> CallOptions withOption(CallOptions.Key<T> key, T value)
Sets a custom option. Any existing value for the key is overwritten.- Parameters:
key
- The option keyvalue
- The option value.- Since:
- 1.13.0
-
getOption
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1869") public <T> T getOption(CallOptions.Key<T> key)
Get the value for a custom option or its inherent default.- Parameters:
key
- Key identifying option
-
getExecutor
@Nullable public Executor getExecutor()
Returns the executor override to use for this specific call, ornull
if there is no override. The executor is only for servicing this one call, so is not safe to use afterClientCall.Listener.onClose(io.grpc.Status, io.grpc.Metadata)
.
-
isWaitForReady
public boolean isWaitForReady()
Returns whether 'wait for ready' option is enabled for the call. 'Fail fast' is the default option for gRPC calls and 'wait for ready' is the opposite to it.
-
withMaxInboundMessageSize
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/2563") public CallOptions withMaxInboundMessageSize(int maxSize)
Sets the maximum allowed message size acceptable from the remote peer. If unset, this will default to the value set on theManagedChannelBuilder.maxInboundMessageSize(int)
.
-
withMaxOutboundMessageSize
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/2563") public CallOptions withMaxOutboundMessageSize(int maxSize)
Sets the maximum allowed message size acceptable sent to the remote peer.
-
getMaxInboundMessageSize
@Nullable @ExperimentalApi("https://github.com/grpc/grpc-java/issues/2563") public Integer getMaxInboundMessageSize()
Gets the maximum allowed message size acceptable from the remote peer.
-
getMaxOutboundMessageSize
@Nullable @ExperimentalApi("https://github.com/grpc/grpc-java/issues/2563") public Integer getMaxOutboundMessageSize()
Gets the maximum allowed message size acceptable to send the remote peer.
-
-