QuicOptions.Builder

Kotlin |Java

public static final class QuicOptions.Builder
extends Object

java.lang.Object
↳	android.net.http.QuicOptions.Builder

Builder for QuicOptions.

Summary

Public constructors
`Builder()`

Public methods
`QuicOptions.Builder`	`addAllowedQuicHost(String quicHost)` Adds a host to the QUIC allowlist.
`QuicOptions`	`build()` Creates and returns the final `QuicOptions` instance, based on the values in this builder.
`QuicOptions.Builder`	`setHandshakeUserAgent(String handshakeUserAgent)` Sets the user agent to be used outside of HTTP requests (for example for QUIC handshakes).
`QuicOptions.Builder`	`setIdleConnectionTimeout(Duration idleConnectionTimeout)` Sets the maximum idle time for a connection.
`QuicOptions.Builder`	`setInMemoryServerConfigsCacheSize(int inMemoryServerConfigsCacheSize)` Sets how many server configurations (metadata like list of alt svc, whether QUIC is supported, etc.) should be held in memory.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Builder

Added in API level 34
Also in S Extensions 7

public Builder ()

Public methods

addAllowedQuicHost

Added in API level 34
Also in S Extensions 7

public QuicOptions.Builder addAllowedQuicHost (String quicHost)

Adds a host to the QUIC allowlist.

If no hosts are specified, the per-host allowlist functionality is disabled. Otherwise, the HTTP stack will only use QUIC when talking to hosts on the allowlist.

Parameters
`quicHost`	`String`: This value cannot be `null`.

Returns
`QuicOptions.Builder`	the builder for chaining This value cannot be `null`.

build

Added in API level 34
Also in S Extensions 7

public QuicOptions build ()

Creates and returns the final QuicOptions instance, based on the values in this builder.

Returns
`QuicOptions`	This value cannot be `null`.

setHandshakeUserAgent

Added in API level 34
Also in S Extensions 7

public QuicOptions.Builder setHandshakeUserAgent (String handshakeUserAgent)

Sets the user agent to be used outside of HTTP requests (for example for QUIC handshakes).

To set the default user agent for HTTP requests, use HttpEngine.Builder#setUserAgent(String) instead.

Parameters
`handshakeUserAgent`	`String`: This value cannot be `null`.

Returns
`QuicOptions.Builder`	the builder for chaining This value cannot be `null`.

setIdleConnectionTimeout

Added in API level 34
Also in S Extensions 7

public QuicOptions.Builder setIdleConnectionTimeout (Duration idleConnectionTimeout)

Sets the maximum idle time for a connection. The actual value for the idle timeout is the minimum of this value and the server's and is negotiated during the handshake. Thus, it only applies after the handshake has completed. If no activity is detected on the connection for the set duration, the connection is closed.

See RFC 9114, section 5.1 for more details.

Parameters
`idleConnectionTimeout`	`Duration`: This value cannot be `null`.

Returns
`QuicOptions.Builder`	the builder for chaining This value cannot be `null`.

setInMemoryServerConfigsCacheSize

Added in API level 34
Also in S Extensions 7

public QuicOptions.Builder setInMemoryServerConfigsCacheSize (int inMemoryServerConfigsCacheSize)

Sets how many server configurations (metadata like list of alt svc, whether QUIC is supported, etc.) should be held in memory.

If the storage path is set (HttpEngine.Builder#setStoragePath(String), the HTTP stack will also persist the server configurations on disk.

Parameters
`inMemoryServerConfigsCacheSize`	`int`

Returns
`QuicOptions.Builder`	the builder for chaining This value cannot be `null`.