net.luminis.quic.QuicConnection Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2020, 2021, 2022, 2023, 2024 Peter Doornbosch
 *
 * This file is part of Kwik, an implementation of the QUIC protocol in Java.
 *
 * Kwik is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your option)
 * any later version.
 *
 * Kwik is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
 * more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see .
 */
package net.luminis.quic;

import java.time.Duration;
import java.util.function.Consumer;


public interface QuicConnection {

    enum QuicVersion {
        V1,
        V2,
    }

    QuicVersion getQuicVersion();

    /**
     * Sets the maximum number of peer initiated bidirectional streams that the peer is allowed to have open at any time.
     * If the value is 0, the peer is not allowed to open any bidirectional stream.
     * This method must be called before calling connect().
     * @param max
     * @deprecated use
     * QuicClientConnection.Builder.maxOpenPeerInitiatedBidirectionalStreams(int)
     * or
     * ServerConnector.Builder.withConfiguration(ServerConnectionConfig)
     * with ServerConnectionConfig.Builder.maxOpenPeerInitiatedBidirectionalStreams(int)
     * instead
     */
    @Deprecated
    void setMaxAllowedBidirectionalStreams(int max);

    /**
     * Sets the maximum number of peer initiated unidirectional streams that the peer is allowed to have open at any time.
     * If the value is 0, the peer is not allowed to open any unidirectional stream.
     * This method must be called before calling connect().
     * @param max
     * @deprecated use
     * QuicClientConnection.Builder.maxOpenPeerInitiatedUnidirectionalStreams(int)
     * or
     * ServerConnector.Builder.withConfiguration(ServerConnectionConfig)
     * with ServerConnectionConfig.Builder.maxOpenPeerInitiatedUnidirectionalStreams(int)
     * instead
     */
    @Deprecated
    void setMaxAllowedUnidirectionalStreams(int max);

    /**
     * Set the maximum size of the stream receive buffer.
     * @param size
     * @deprecated use setDefaultUnidirectionalStreamReceiveBufferSize(long) or setDefaultBidirectionalStreamReceiveBufferSize(long)
     */
    @Deprecated
    void setDefaultStreamReceiveBufferSize(long size);

    /**
     * Set the maximum size of the stream receive buffer for (peer initiated) unidirectional streams.
     * @param size  the new max buffer size, must be a value between 1024 en the connection buffer size
     * @throws IllegalArgumentException when the new size is larger than the connection buffer size or less than 1024
     */
    void setDefaultUnidirectionalStreamReceiveBufferSize(long size);

    /**
     * Set the maximum size of the stream receive buffer for bidirectional streams (both self-initiated or peer-initiated).
     * @param size  the new max buffer size, must be a value between 1024 en the connection buffer size
     * @throws IllegalArgumentException when the new size is larger than the connection buffer size or less than 1024
     */
    void setDefaultBidirectionalStreamReceiveBufferSize(long size);

    QuicStream createStream(boolean bidirectional);

    void setPeerInitiatedStreamCallback(Consumer streamConsumer);

    void close();

    /**
     * Closes the connection and wait for the close to complete. This close method should be used when called just before
     * the JVM shuts down, to enable the QUIC connection to close properly (send connection close frame and retransmit
     * if lost).
     */
    void closeAndWait();

    /**
     * Closes the connection and wait for the close to complete. This close method should be used when called just before
     * the JVM shuts down, to enable the QUIC connection to close properly (send connection close frame and retransmit
     * if lost).
     *
     * @param maxWait     maximum time to wait before returning.
     */
    void closeAndWait(Duration maxWait);

    void close(QuicConstants.TransportErrorCode applicationError, String errorReason);

    /**
     * Close the connection with an application error code and reason.
     * @param applicationErrorCode
     * @param errorReason
     */
    void close(long applicationErrorCode, String errorReason);

    Statistics getStats();
}