Modifier and Type	Class and Description
public static class	QuicClient.Builder
private static record	QuicClient.InitialTokenRecipient

Modifier and Type	Field and Description
private final LongFunction<String>	appErrorCodeToString
private final List<QuicVersion>	availableVersions
private final InetSocketAddress	bindAddress
private final String	clientId
private volatile boolean	closed
private static final AtomicLong	CONNECTIONS
private final Logger	debug
pack-priv static final int	DEFAULT_MAX_ENDPOINTS
private final QuicEndpoint.QuicEndpointFactory	endpointFactory
private final QuicEndpoint[]	endpoints
private final Executor	executor
private static final AtomicLong	IDS
pack-priv static final int	INITIAL_SERVER_CONNECTION_ID_LENGTH
private final Map<QuicClient.InitialTokenRecipient, byte[]>	initialTokens
private int	insertionPoint
private final ReentrantLock	lock
pack-priv static final int	MAX_ENDPOINTS_LIMIT
private final String	name
private final QuicTLSContext	quicTLSContext
private volatile QuicSelector<?>	selector
pack-priv static final int	SMALLEST_MAXIMUM_DATAGRAM_SIZE
private final SSLParameters	sslParameters
private final QuicTransportParameters	transportParams

Access	Constructor and Description
private	QuicClient(final QuicClient.Builder builder)

Method Summary

Modifier and Type	Method and Description
public void	abort(Throwable t)
private void	abortEndpoint(QuicEndpoint endpoint, Throwable cause)
public String	appErrorToString(long code) Overrides default jdk.internal.net.http.quic.QuicInstance.appErrorToString. Returns a string describing the given application error code.
public InetSocketAddress	Returns: the address that the QuicEndpoint will bind to. bindAddress() The address that the QuicEndpoint will bind to.
private QuicEndpoint	chooseEndpoint()
public String	Returns: A string identifying the HttpClientImpl instance. clientId() The HttpClientImpl Id. used to identify the client in debug traces.
public void	close() Implements java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources.
private void	closeEndpoint(QuicEndpoint endpoint)
private static int	computeMaxEndpoints()
public QuicConnectionImpl	Returns: a new unconnected `QuicConnection` createConnectionFor(final AltServicesRegistry.AltService the alternate service for which to create the connection for service) Creates a new unconnected `QuicConnection` to the given `service`.
public QuicConnectionImpl	Returns: a new unconnected `QuicConnection` createConnectionFor(final InetSocketAddress the address of the peer peerAddress, final String[] alpns) Creates a new unconnected `QuicConnection` to the given `peerAddress`.
private QuicEndpoint	Returns: the new QuicEndpoint createEndpoint(final String endpointName) Creates an endpoint with the given name, and register it with a selector.
private SSLParameters	createSSLParameters(final String[] alpns)
public Executor	Returns: the executor used by this QuicClient. executor() Implements jdk.internal.net.http.quic.QuicInstance.executor. The executor used by this QuicClient when a task needs to be offloaded to a separate thread.
public List<QuicVersion>	Returns: the versions that are available for use on this instance, in the descending order of their preference getAvailableVersions() Implements jdk.internal.net.http.quic.QuicInstance.getAvailableVersions. Returns the versions that are available for use on this instance, in the descending order of their preference.
public QuicEndpoint	getEndpoint() Implements jdk.internal.net.http.quic.QuicInstance.getEndpoint. Returns an endpoint to associate with a connection.
public QuicTLSContext	getQuicTLSContext() Implements jdk.internal.net.http.quic.QuicInstance.getQuicTLSContext. Get the QuicTLSContext used by this quic instance.
public SSLParameters	getSSLParameters() Overrides default jdk.internal.net.http.quic.QuicInstance.getSSLParameters. The `SSLParameters` for this Quic instance.
public QuicTransportParameters	getTransportParameters() Implements jdk.internal.net.http.quic.QuicInstance.getTransportParameters.
pack-priv byte[]	initialTokenFor(final InetSocketAddress The address of the server peerAddress) Returns: the initial token to use in INITIAL packets during connection establishment against a server represented by the `peerAddress`.
public String	instanceId() Implements jdk.internal.net.http.quic.QuicInstance.instanceId. Instance ID used for debugging traces.
public boolean	isVersionAvailable(final QuicVersion quicVersion) Implements jdk.internal.net.http.quic.QuicInstance.isVersionAvailable. Returns true if the passed version is available for use on this instance, false otherwise.
public String	Returns: the name identifying this QuicClient. name() Overrides default jdk.internal.net.http.quic.QuicInstance.name. The name identifying this QuicClient, used in debug traces.
private static String	nextName()
pack-priv void	registerInitialToken(final InetSocketAddress The address of the server peerAddress, final byte[] The token to use token) Registers a token to use in INITIAL packets during connection establishment against a server represented by the `peerAddress`.
private static SSLParameters	requireTLS13(final SSLParameters parameters)
public void	unmatchedQuicPacket(SocketAddress source, QuicPacket.HeadersType type, ByteBuffer buffer) Implements jdk.internal.net.http.quic.QuicInstance.unmatchedQuicPacket. This method is called when a quic packet that couldn't be attributed to a registered connection is received.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

appErrorCodeToString	back to summary
private final LongFunction<String> appErrorCodeToString

availableVersions	back to summary
private final List<QuicVersion> availableVersions

bindAddress	back to summary
private final InetSocketAddress bindAddress

clientId	back to summary
private final String clientId

closed	back to summary
private volatile boolean closed

CONNECTIONS	back to summary
private static final AtomicLong CONNECTIONS

debug	back to summary
private final Logger debug

DEFAULT_MAX_ENDPOINTS	back to summary
pack-priv static final int DEFAULT_MAX_ENDPOINTS

endpointFactory	back to summary
private final QuicEndpoint.QuicEndpointFactory endpointFactory

endpoints	back to summary
private final QuicEndpoint[] endpoints

executor	back to summary
private final Executor executor

IDS	back to summary
private static final AtomicLong IDS

INITIAL_SERVER_CONNECTION_ID_LENGTH	back to summary
pack-priv static final int INITIAL_SERVER_CONNECTION_ID_LENGTH

initialTokens	back to summary
private final Map<QuicClient.InitialTokenRecipient, byte[]> initialTokens

insertionPoint	back to summary
private int insertionPoint

lock	back to summary
private final ReentrantLock lock

MAX_ENDPOINTS_LIMIT	back to summary
pack-priv static final int MAX_ENDPOINTS_LIMIT

name	back to summary
private final String name

quicTLSContext	back to summary
private final QuicTLSContext quicTLSContext

selector	back to summary
private volatile QuicSelector<?> selector

SMALLEST_MAXIMUM_DATAGRAM_SIZE	back to summary
pack-priv static final int SMALLEST_MAXIMUM_DATAGRAM_SIZE

sslParameters	back to summary
private final SSLParameters sslParameters

transportParams	back to summary
private final QuicTransportParameters transportParams

Constructor Detail

QuicClient	back to summary
private QuicClient(final QuicClient.Builder builder)

Method Detail

abort	back to summary
public void abort(Throwable t)

abortEndpoint	back to summary
private void abortEndpoint(QuicEndpoint endpoint, Throwable cause)

appErrorToString	back to summary
public String appErrorToString(long code) Overrides default jdk.internal.net.http.quic.QuicInstance.appErrorToString. Doc from jdk.internal.net.http.quic.QuicInstance.appErrorToString. Returns a string describing the given application error code. Annotations @Override

appErrorToString

back to summary

public String appErrorToString(long code)

Overrides default jdk.internal.net.http.quic.QuicInstance.appErrorToString.

Doc from jdk.internal.net.http.quic.QuicInstance.appErrorToString.

Returns a string describing the given application error code.

Annotations

@Override

bindAddress	back to summary
public InetSocketAddress bindAddress() The address that the QuicEndpoint will bind to. Implementation Note By default, this is wildcard:0 Returns:InetSocketAddress the address that the QuicEndpoint will bind to.

bindAddress

back to summary

public InetSocketAddress bindAddress()

The address that the QuicEndpoint will bind to.

Implementation Note

By default, this is wildcard:0

Returns:InetSocketAddress: the address that the QuicEndpoint will bind to.

chooseEndpoint	back to summary
private QuicEndpoint chooseEndpoint() throws IOException

clientId	back to summary
public String clientId() The HttpClientImpl Id. used to identify the client in debug traces. Returns:String A string identifying the HttpClientImpl instance.

clientId

back to summary

public String clientId()

The HttpClientImpl Id. used to identify the client in debug traces.

Returns:String: A string identifying the HttpClientImpl instance.

close back to summary

close	back to summary
public void close() Implements java.lang.AutoCloseable.close. Doc from java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the `try`-with-resources statement. Annotations @Override

public void close()

Implements java.lang.AutoCloseable.close.

Doc from java.lang.AutoCloseable.close.

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Annotations

@Override

closeEndpoint	back to summary
private void closeEndpoint(QuicEndpoint endpoint)

computeMaxEndpoints	back to summary
private static int computeMaxEndpoints()

createConnectionFor back to summary

createConnectionFor	back to summary
public QuicConnectionImpl createConnectionFor(final AltServicesRegistry.AltService service) Creates a new unconnected `QuicConnection` to the given `service`. API Note The caller is expected to call `QuicConnectionImpl#startHandshake()` to initiate the handshaking. The connection is considered "connected" when the handshake is successfully completed. Parameters service:AltServicesRegistry.AltService the alternate service for which to create the connection for Returns:QuicConnectionImpl a new unconnected `QuicConnection` Exceptions IllegalArgumentException: if the ALPN of this transport isn't the same as that of the passed alternate service

public QuicConnectionImpl createConnectionFor(final AltServicesRegistry.AltService service)

Creates a new unconnected QuicConnection to the given service.

API Note

The caller is expected to call QuicConnectionImpl#startHandshake() to initiate the handshaking. The connection is considered "connected" when the handshake is successfully completed.

Parameters

service:AltServicesRegistry.AltService: the alternate service for which to create the connection for

Returns:QuicConnectionImpl

a new unconnected QuicConnection

Exceptions

IllegalArgumentException:: if the ALPN of this transport isn't the same as that of the passed alternate service

createConnectionFor back to summary

createConnectionFor	back to summary
public QuicConnectionImpl createConnectionFor(final InetSocketAddress peerAddress, final String[] alpns) Creates a new unconnected `QuicConnection` to the given `peerAddress`. API Note The caller is expected to call `QuicConnectionImpl#startHandshake()` to initiate the handshaking. The connection is considered "connected" when the handshake is successfully completed. Parameters peerAddress:InetSocketAddress the address of the peer Returns:QuicConnectionImpl a new unconnected `QuicConnection`

public QuicConnectionImpl createConnectionFor(final InetSocketAddress peerAddress, final String[] alpns)

Creates a new unconnected QuicConnection to the given peerAddress.

API Note

The caller is expected to call QuicConnectionImpl#startHandshake() to initiate the handshaking. The connection is considered "connected" when the handshake is successfully completed.

Parameters

peerAddress:InetSocketAddress: the address of the peer

Returns:QuicConnectionImpl

a new unconnected QuicConnection

createEndpoint	back to summary
private QuicEndpoint createEndpoint(final String endpointName) throws IOException Creates an endpoint with the given name, and register it with a selector. Returns:QuicEndpoint the new QuicEndpoint Exceptions IOException: if an error occurs when setting up the selector or linking the transport with the selector. IllegalStateException: if the client is closed.

createEndpoint

back to summary

private QuicEndpoint createEndpoint(final String endpointName) throws IOException

Creates an endpoint with the given name, and register it with a selector.

Returns:QuicEndpoint

the new QuicEndpoint

Exceptions

IOException:: if an error occurs when setting up the selector or linking the transport with the selector.
IllegalStateException:: if the client is closed.

createSSLParameters	back to summary
private SSLParameters createSSLParameters(final String[] alpns)

executor	back to summary
public Executor executor() Implements jdk.internal.net.http.quic.QuicInstance.executor. The executor used by this QuicClient when a task needs to be offloaded to a separate thread. Implementation Note This is the HttpClientImpl internal executor. Returns:Executor the executor used by this QuicClient. Annotations @Override

executor

back to summary

public Executor executor()

Implements jdk.internal.net.http.quic.QuicInstance.executor.

The executor used by this QuicClient when a task needs to be offloaded to a separate thread.

Implementation Note

This is the HttpClientImpl internal executor.

Returns:Executor

the executor used by this QuicClient.

Annotations

@Override

getAvailableVersions	back to summary
public List<QuicVersion> getAvailableVersions() Implements jdk.internal.net.http.quic.QuicInstance.getAvailableVersions. Returns the versions that are available for use on this instance, in the descending order of their preference. Returns:List<QuicVersion> the versions that are available for use on this instance, in the descending order of their preference Annotations @Override

getAvailableVersions

back to summary

public List<QuicVersion> getAvailableVersions()

Implements jdk.internal.net.http.quic.QuicInstance.getAvailableVersions.

Returns the versions that are available for use on this instance, in the descending order of their preference.

Returns:List<QuicVersion>

the versions that are available for use on this instance, in the descending order of their preference

Annotations

@Override

getEndpoint	back to summary
public QuicEndpoint getEndpoint() throws IOException Implements jdk.internal.net.http.quic.QuicInstance.getEndpoint. Doc from jdk.internal.net.http.quic.QuicInstance.getEndpoint. Returns an endpoint to associate with a connection. Annotations @Override

getEndpoint

back to summary

public QuicEndpoint getEndpoint() throws IOException

Implements jdk.internal.net.http.quic.QuicInstance.getEndpoint.

Doc from jdk.internal.net.http.quic.QuicInstance.getEndpoint.

Returns an endpoint to associate with a connection.

Annotations

@Override

getQuicTLSContext	back to summary
public QuicTLSContext getQuicTLSContext() Implements jdk.internal.net.http.quic.QuicInstance.getQuicTLSContext. Doc from jdk.internal.net.http.quic.QuicInstance.getQuicTLSContext. Get the QuicTLSContext used by this quic instance. Annotations @Override

getQuicTLSContext

back to summary

public QuicTLSContext getQuicTLSContext()

Implements jdk.internal.net.http.quic.QuicInstance.getQuicTLSContext.

Doc from jdk.internal.net.http.quic.QuicInstance.getQuicTLSContext.

Get the QuicTLSContext used by this quic instance.

Annotations

@Override

getSSLParameters back to summary

getSSLParameters	back to summary
public SSLParameters getSSLParameters() Overrides default jdk.internal.net.http.quic.QuicInstance.getSSLParameters. Doc from jdk.internal.net.http.quic.QuicInstance.getSSLParameters. The `SSLParameters` for this Quic instance. May be `null` if no parameters have been specified. Annotations @Override

public SSLParameters getSSLParameters()

Overrides default jdk.internal.net.http.quic.QuicInstance.getSSLParameters.

Doc from jdk.internal.net.http.quic.QuicInstance.getSSLParameters.

The SSLParameters for this Quic instance. May be null if no parameters have been specified.

Annotations

@Override

getTransportParameters	back to summary
public QuicTransportParameters getTransportParameters() Implements jdk.internal.net.http.quic.QuicInstance.getTransportParameters. Annotations @Override

getTransportParameters

back to summary

public QuicTransportParameters getTransportParameters()

Implements jdk.internal.net.http.quic.QuicInstance.getTransportParameters.

Annotations

@Override

initialTokenFor	back to summary
pack-priv byte[] initialTokenFor(final InetSocketAddress peerAddress) Parameters peerAddress:InetSocketAddress The address of the server Returns:byte[] the initial token to use in INITIAL packets during connection establishment against a server represented by the `peerAddress`. Returns null if no token exists for the server.

instanceId	back to summary
public String instanceId() Implements jdk.internal.net.http.quic.QuicInstance.instanceId. Doc from jdk.internal.net.http.quic.QuicInstance.instanceId. Instance ID used for debugging traces. Annotations @Override

instanceId

back to summary

public String instanceId()

Implements jdk.internal.net.http.quic.QuicInstance.instanceId.

Doc from jdk.internal.net.http.quic.QuicInstance.instanceId.

Instance ID used for debugging traces.

Annotations

@Override

isVersionAvailable	back to summary
public boolean isVersionAvailable(final QuicVersion quicVersion) Implements jdk.internal.net.http.quic.QuicInstance.isVersionAvailable. Doc from jdk.internal.net.http.quic.QuicInstance.isVersionAvailable. Returns true if the passed version is available for use on this instance, false otherwise. Annotations @Override

isVersionAvailable

back to summary

public boolean isVersionAvailable(final QuicVersion quicVersion)

Implements jdk.internal.net.http.quic.QuicInstance.isVersionAvailable.

Doc from jdk.internal.net.http.quic.QuicInstance.isVersionAvailable.

Returns true if the passed version is available for use on this instance, false otherwise.

Annotations

@Override

name back to summary

public String name()

Overrides default jdk.internal.net.http.quic.QuicInstance.name.

The name identifying this QuicClient, used in debug traces.

Implementation Note

This is "QuicClient(<clientId>)".

Returns:String: the name identifying this QuicClient.

nextName	back to summary
private static String nextName()

registerInitialToken back to summary

pack-priv void registerInitialToken(final InetSocketAddress peerAddress, final byte[] token)

Registers a token to use in INITIAL packets during connection establishment against a server represented by the peerAddress.

Parameters

peerAddress:InetSocketAddress: The address of the server
token:byte[]: The token to use

Exceptions

NullPointerException:: If either of peerAddress or token is null
IllegalArgumentException:: If the token is of zero length

requireTLS13	back to summary
private static SSLParameters requireTLS13(final SSLParameters parameters)

unmatchedQuicPacket

back to summary

public void unmatchedQuicPacket(SocketAddress source, QuicPacket.HeadersType type, ByteBuffer buffer)

Implements jdk.internal.net.http.quic.QuicInstance.unmatchedQuicPacket.

Doc from jdk.internal.net.http.quic.QuicInstance.unmatchedQuicPacket.

This method is called when a quic packet that couldn't be attributed to a registered connection is received.

Annotations

@Override

jdk.internal.net.http.quic back to summary

public final Class QuicClient.Builder

Class Inheritance

extends Object

java.lang.Object
jdk.internal.net.http.quic.QuicClient.Builder

Field Summary

Modifier and Type	Field and Description
private LongFunction<String>	appErrorCodeToString
private List<QuicVersion>	availableVersions
private InetSocketAddress	bindAddr
private String	clientId
private Executor	executor
private SSLParameters	sslParams
private QuicTLSContext	tlsContext
private QuicTransportParameters	transportParams

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public QuicClient.Builder	applicationErrors(LongFunction<String> errorCodeToString)
public QuicClient.Builder	availableVersions(final List<QuicVersion> versions)
public QuicClient.Builder	availableVersions(final QuicVersion version, final QuicVersion... more)
public QuicClient.Builder	bindAddress(final InetSocketAddress bindAddr)
public QuicClient	build()
public QuicClient.Builder	clientId(final String clientId)
public QuicClient.Builder	executor(final Executor executor)
public QuicClient.Builder	sslParameters(final SSLParameters sslParameters)
public QuicClient.Builder	tlsContext(final QuicTLSContext tlsContext)
public QuicClient.Builder	transportParameters(final QuicTransportParameters transportParams)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

appErrorCodeToString	back to summary
private LongFunction<String> appErrorCodeToString

availableVersions	back to summary
private List<QuicVersion> availableVersions

bindAddr	back to summary
private InetSocketAddress bindAddr

clientId	back to summary
private String clientId

executor	back to summary
private Executor executor

sslParams	back to summary
private SSLParameters sslParams

tlsContext	back to summary
private QuicTLSContext tlsContext

transportParams	back to summary
private QuicTransportParameters transportParams

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

applicationErrors	back to summary
public QuicClient.Builder applicationErrors(LongFunction<String> errorCodeToString)

availableVersions	back to summary
public QuicClient.Builder availableVersions(final List<QuicVersion> versions)

availableVersions	back to summary
public QuicClient.Builder availableVersions(final QuicVersion version, final QuicVersion... more)

bindAddress	back to summary
public QuicClient.Builder bindAddress(final InetSocketAddress bindAddr)

build	back to summary
public QuicClient build()

clientId	back to summary
public QuicClient.Builder clientId(final String clientId)

executor	back to summary
public QuicClient.Builder executor(final Executor executor)

sslParameters	back to summary
public QuicClient.Builder sslParameters(final SSLParameters sslParameters)

tlsContext	back to summary
public QuicClient.Builder tlsContext(final QuicTLSContext tlsContext)

transportParameters	back to summary
public QuicClient.Builder transportParameters(final QuicTransportParameters transportParams)

jdk.internal.net.http.quic back to summary

private final Record QuicClient.InitialTokenRecipient

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
jdk.internal.net.http.quic.QuicClient.InitialTokenRecipient

Record Components

host:String
port:int

Field Summary

Modifier and Type	Field and Description
private final String	host Record Component accessed by host().
private final int	port Record Component accessed by port().

Constructor Summary

Access	Constructor and Description
private	InitialTokenRecipient(String host, int port)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public String	host() Record Component getter of host.
public int	port() Record Component getter of port.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

host	back to summary
private final String host Record Component accessed by host().

port	back to summary
private final int port Record Component accessed by port().

Constructor Detail

InitialTokenRecipient	back to summary
private InitialTokenRecipient(String host, int port)

Method Detail

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

host	back to summary
public String host() Record Component getter of host.

port	back to summary
public int port() Record Component getter of port.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final Class QuicClient

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class QuicClient.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record QuicClient.InitialTokenRecipient

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail