QuicConnectionCloseEvent Class — netty Architecture

Source Code

codec-classes-quic/src/main/java/io/netty/handler/codec/quic/QuicConnectionCloseEvent.java lines 25–96

public final class QuicConnectionCloseEvent implements QuicEvent {

    final boolean applicationClose;
    final int error;
    final byte[] reason;

    QuicConnectionCloseEvent(boolean applicationClose, int error, byte[] reason) {
        this.applicationClose = applicationClose;
        this.error = error;
        this.reason = reason;
    }

    /**
     * Return {@code true} if this was an application close, {@code false} otherwise.
     *
     * @return  if this is an application close.
     */
    public boolean isApplicationClose() {
        return applicationClose;
    }

    /**
     * Return the error that was provided for the close.
     *
     * @return the error.
     */
    public int error() {
        return error;
    }

    /**
     * Returns {@code true} if a <a href="https://www.rfc-editor.org/rfc/rfc9001#section-4.8">TLS error</a>
     * is contained.
     * @return {@code true} if this is an {@code TLS error}, {@code false} otherwise.
     */
    public boolean isTlsError() {
        return !applicationClose && error >= 0x0100;
    }

    /**
     * Returns the reason for the close, which may be empty if no reason was given as part of the close.
     *
     * @return  the reason.
     */
    public byte[] reason() {
        return reason.clone();
    }

    @Override
    public String toString() {
        return "QuicConnectionCloseEvent{" +
                "applicationClose=" + applicationClose +
                ", error=" + error +
                ", reason=" + Arrays.toString(reason) +
                '}';
    }

    /**
     * Extract the contained {@code TLS error} from the {@code QUIC error}. If the given {@code QUIC error} does not
     * contain a {@code TLS error} it will return {@code -1}.
     *
     * @param error the {@code QUIC error}
     * @return      the {@code TLS error} or {@code -1} if there was no {@code TLS error} contained.
     */
    public static int extractTlsError(int error) {
        int tlsError = error - 0x0100;
        if (tlsError < 0) {
            return -1;
        }
        return tlsError;
    }
}