OpenJDK 27 · jdk.internal.net.http.quic.ConnectionTerminatorImpl

Modifier and Type	Field and Description
private final QuicConnectionImpl	connection
private final Logger	debug
private final CompletableFuture<TerminationCause>	futureTC
private final String	logTag
private final AtomicReference<TerminationCause>	terminationCause

Access	Constructor and Description
pack-priv	ConnectionTerminatorImpl(final QuicConnectionImpl connection)

Method Summary

Modifier and Type	Method and Description
public void	appLayerMaxIdle(final Duration maxIdle, final Supplier<Boolean> trafficGenerationCheck) Implements jdk.internal.net.http.quic.ConnectionTerminator.appLayerMaxIdle. Instructs the connection terminator that the application layer allows the connection to stay idle for the given `maxIdle` duration.
private void	discardConnectionState()
private void	doTerminate(final TerminationCause cause)
private void	drain(final ConnectionCloseFrame incomingFrame)
private void	failHandshakeCFs()
private void	failHandshakeCFs(final Throwable cause)
pack-priv CompletableFuture<TerminationCause>	futureTerminationCause()
pack-priv TerminationCause	getTerminationCause()
private void	immediateClose(final ConnectionCloseFrame closeFrame, final QuicTLSEngine.KeySpace keySpace, final TerminationCause terminationCause)
pack-priv void	incomingConnectionCloseFrame(final ConnectionCloseFrame frame)
pack-priv void	incomingStatelessReset()
pack-priv ByteBuffer	Returns: the datagram containing the QUIC packet with a CONNECTION_CLOSE frame makeConnectionCloseDatagram() Returns a `ByteBuffer` which contains an encrypted QUIC packet containing a CONNECTION_CLOSE frame.
private boolean	mark(final int mask, final TerminationCause cause)
public void	markActive() Implements jdk.internal.net.http.quic.ConnectionTerminator.markActive. Instructs the connection terminator to consider the connection as active at the present point in time.
private boolean	markClosed(final TerminationCause terminationCause)
private boolean	markClosing(final TerminationCause terminationCause)
private boolean	markDraining(final TerminationCause terminationCause)
private void	pushConnectionCloseFrame(final QuicTLSEngine.KeySpace the KeySpace to use for sending the packet keySpace, final ConnectionCloseFrame the CONNECTION_CLOSE frame frame) CONNECTION_CLOSE frame is not congestion controlled (RFC-9002 section 3 and RFC-9000 section 12.4, table 3), nor is it queued or scheduled for sending.
private void	silentTerminate(final TerminationCause.SilentTermination terminationCause) Called only when the connection is expected to be discarded without being required to inform the peer.
public void	terminate(final TerminationCause cause) Implements jdk.internal.net.http.quic.ConnectionTerminator.terminate. Terminates the connection, if not already terminated, with the given cause.
public boolean	tryReserveForUse() Implements jdk.internal.net.http.quic.ConnectionTerminator.tryReserveForUse. Returns `true` if the connection is allowed for use, `false` otherwise.
private void	unregisterConnFromEndpoint()

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

connection	back to summary
private final QuicConnectionImpl connection

debug	back to summary
private final Logger debug

futureTC	back to summary
private final CompletableFuture<TerminationCause> futureTC

logTag	back to summary
private final String logTag

terminationCause	back to summary
private final AtomicReference<TerminationCause> terminationCause

ConnectionTerminatorImpl	back to summary
pack-priv ConnectionTerminatorImpl(final QuicConnectionImpl connection)

Method Detail

appLayerMaxIdle back to summary

appLayerMaxIdle	back to summary
public void appLayerMaxIdle(final Duration maxIdle, final Supplier<Boolean> trafficGenerationCheck) Implements jdk.internal.net.http.quic.ConnectionTerminator.appLayerMaxIdle. Doc from jdk.internal.net.http.quic.ConnectionTerminator.appLayerMaxIdle. Instructs the connection terminator that the application layer allows the connection to stay idle for the given `maxIdle` duration. If the QUIC layer has negotiated an idle timeout for the connection, that's lower than the application's `maxIdle` duration, then the connection terminator upon noticing absence of traffic over the connection for certain duration, calls the `trafficGenerationCheck` to check if the QUIC layer should explicitly generate some traffic to prevent the connection from idle terminating. When the `trafficGenerationCheck` is invoked, the application layer must return `true` only if explicit traffic generation is necessary to keep the connection alive. If the application layer wishes to never idle terminate the connection, then a `maxIdle` duration of Duration.MAX is recommended. Annotations @Override

public void appLayerMaxIdle(final Duration maxIdle, final Supplier<Boolean> trafficGenerationCheck)

Implements jdk.internal.net.http.quic.ConnectionTerminator.appLayerMaxIdle.

Doc from jdk.internal.net.http.quic.ConnectionTerminator.appLayerMaxIdle.

Instructs the connection terminator that the application layer allows the connection to stay idle for the given maxIdle duration. If the QUIC layer has negotiated an idle timeout for the connection, that's lower than the application's maxIdle duration, then the connection terminator upon noticing absence of traffic over the connection for certain duration, calls the trafficGenerationCheck to check if the QUIC layer should explicitly generate some traffic to prevent the connection from idle terminating.

When the trafficGenerationCheck is invoked, the application layer must return true only if explicit traffic generation is necessary to keep the connection alive.

If the application layer wishes to never idle terminate the connection, then a maxIdle duration of Duration.MAX is recommended.

Annotations

@Override

discardConnectionState	back to summary
private void discardConnectionState()

doTerminate	back to summary
private void doTerminate(final TerminationCause cause)

drain	back to summary
private void drain(final ConnectionCloseFrame incomingFrame)

failHandshakeCFs	back to summary
private void failHandshakeCFs()

failHandshakeCFs	back to summary
private void failHandshakeCFs(final Throwable cause)

futureTerminationCause	back to summary
pack-priv CompletableFuture<TerminationCause> futureTerminationCause()

getTerminationCause	back to summary
pack-priv TerminationCause getTerminationCause()

immediateClose	back to summary
private void immediateClose(final ConnectionCloseFrame closeFrame, final QuicTLSEngine.KeySpace keySpace, final TerminationCause terminationCause)

incomingConnectionCloseFrame	back to summary
pack-priv void incomingConnectionCloseFrame(final ConnectionCloseFrame frame)

incomingStatelessReset	back to summary
pack-priv void incomingStatelessReset()

makeConnectionCloseDatagram back to summary

makeConnectionCloseDatagram	back to summary
pack-priv ByteBuffer makeConnectionCloseDatagram() throws QuicKeyUnavailableException, QuicTransportException Returns a `ByteBuffer` which contains an encrypted QUIC packet containing a CONNECTION_CLOSE frame. The CONNECTION_CLOSE frame will have a frame type of `0x1c` and error code of `NO_ERROR`. This method should only be invoked when the `QuicEndpoint` is being closed and the endpoint wants to send out a `CONNECTION_CLOSE` frame on a best-effort basis (in a fire and forget manner). Returns:ByteBuffer the datagram containing the QUIC packet with a CONNECTION_CLOSE frame

pack-priv ByteBuffer makeConnectionCloseDatagram() throws QuicKeyUnavailableException, QuicTransportException

Returns a ByteBuffer which contains an encrypted QUIC packet containing a CONNECTION_CLOSE frame. The CONNECTION_CLOSE frame will have a frame type of 0x1c and error code of NO_ERROR.

This method should only be invoked when the QuicEndpoint is being closed and the endpoint wants to send out a CONNECTION_CLOSE frame on a best-effort basis (in a fire and forget manner).

Returns:ByteBuffer: the datagram containing the QUIC packet with a CONNECTION_CLOSE frame

mark	back to summary
private boolean mark(final int mask, final TerminationCause cause)

markActive	back to summary
public void markActive() Implements jdk.internal.net.http.quic.ConnectionTerminator.markActive. Doc from jdk.internal.net.http.quic.ConnectionTerminator.markActive. Instructs the connection terminator to consider the connection as active at the present point in time. The connection terminator will then restart its idle timeout timer from this point in time. This method must be called when an incoming packet is processed successfully or when an ack-eliciting packet is sent by the local endpoint on the connection. Annotations @Override

markActive

back to summary

public void markActive()

Implements jdk.internal.net.http.quic.ConnectionTerminator.markActive.

Doc from jdk.internal.net.http.quic.ConnectionTerminator.markActive.

Instructs the connection terminator to consider the connection as active at the present point in time. The connection terminator will then restart its idle timeout timer from this point in time.

This method must be called when an incoming packet is processed successfully or when an ack-eliciting packet is sent by the local endpoint on the connection.

Annotations

@Override

markClosed	back to summary
private boolean markClosed(final TerminationCause terminationCause)

markClosing	back to summary
private boolean markClosing(final TerminationCause terminationCause)

markDraining	back to summary
private boolean markDraining(final TerminationCause terminationCause)

pushConnectionCloseFrame back to summary

pushConnectionCloseFrame	back to summary
private void pushConnectionCloseFrame(final QuicTLSEngine.KeySpace keySpace, final ConnectionCloseFrame frame) throws QuicKeyUnavailableException, QuicTransportException CONNECTION_CLOSE frame is not congestion controlled (RFC-9002 section 3 and RFC-9000 section 12.4, table 3), nor is it queued or scheduled for sending. This method constructs a `QuicPacket` containing the `frame` and immediately `pushes the datagram` through the connection. Parameters keySpace:QuicTLSEngine.KeySpace the KeySpace to use for sending the packet frame:ConnectionCloseFrame the CONNECTION_CLOSE frame Exceptions QuicKeyUnavailableException: if the keys for the KeySpace aren't available QuicTransportException: for any QUIC transport exception when sending the packet

private void pushConnectionCloseFrame(final QuicTLSEngine.KeySpace keySpace, final ConnectionCloseFrame frame) throws QuicKeyUnavailableException, QuicTransportException

CONNECTION_CLOSE frame is not congestion controlled (RFC-9002 section 3 and RFC-9000 section 12.4, table 3), nor is it queued or scheduled for sending. This method constructs a QuicPacket containing the frame and immediately pushes the datagram through the connection.

Parameters

keySpace:QuicTLSEngine.KeySpace: the KeySpace to use for sending the packet
frame:ConnectionCloseFrame: the CONNECTION_CLOSE frame

Exceptions

QuicKeyUnavailableException:: if the keys for the KeySpace aren't available
QuicTransportException:: for any QUIC transport exception when sending the packet

silentTerminate	back to summary
private void silentTerminate(final TerminationCause.SilentTermination terminationCause) Called only when the connection is expected to be discarded without being required to inform the peer. Discards all state, no CONNECTION_CLOSE is sent, nor does the connection enter closing or discarding state.

terminate back to summary

terminate	back to summary
public void terminate(final TerminationCause cause) Implements jdk.internal.net.http.quic.ConnectionTerminator.terminate. Doc from jdk.internal.net.http.quic.ConnectionTerminator.terminate. Terminates the connection, if not already terminated, with the given cause. A connection is terminated only once with a `TerminationCause`. However, this method can be called any number of times. If the connection is not already terminated, then this method does the necessary work to terminate the connection. Any subsequent invocations of this method, after the connection has been terminated, will not change the termination cause of the connection. Annotations @Override

public void terminate(final TerminationCause cause)

Implements jdk.internal.net.http.quic.ConnectionTerminator.terminate.

Doc from jdk.internal.net.http.quic.ConnectionTerminator.terminate.

Terminates the connection, if not already terminated, with the given cause.

A connection is terminated only once with a TerminationCause. However, this method can be called any number of times. If the connection is not already terminated, then this method does the necessary work to terminate the connection. Any subsequent invocations of this method, after the connection has been terminated, will not change the termination cause of the connection.

Annotations

@Override

tryReserveForUse back to summary

tryReserveForUse	back to summary
public boolean tryReserveForUse() Implements jdk.internal.net.http.quic.ConnectionTerminator.tryReserveForUse. Doc from jdk.internal.net.http.quic.ConnectionTerminator.tryReserveForUse. Returns `true` if the connection is allowed for use, `false` otherwise. This method is typically called when a connection that has been idle, is about to be used for handling some request. This method allows for co-ordination between the connection usage and the connection terminator to prevent the connection from being idle timed out when it is about to be used for some request. The connection must only be used if this method returns `true`. Annotations @Override

public boolean tryReserveForUse()

Implements jdk.internal.net.http.quic.ConnectionTerminator.tryReserveForUse.

Doc from jdk.internal.net.http.quic.ConnectionTerminator.tryReserveForUse.

Returns true if the connection is allowed for use, false otherwise.

This method is typically called when a connection that has been idle, is about to be used for handling some request. This method allows for co-ordination between the connection usage and the connection terminator to prevent the connection from being idle timed out when it is about to be used for some request. The connection must only be used if this method returns true.

Annotations

@Override

unregisterConnFromEndpoint	back to summary
private void unregisterConnFromEndpoint()

pack-priv final Class ConnectionTerminatorImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail