FlushStrategy Type — netty Architecture

Source Code

codec-classes-quic/src/main/java/io/netty/handler/codec/quic/FlushStrategy.java lines 23–60

public interface FlushStrategy {

    /**
     * Default {@link FlushStrategy} implementation.
     */
    FlushStrategy DEFAULT = afterNumBytes(20 * Quic.MAX_DATAGRAM_SIZE);

    /**
     * Returns {@code true} if a flush should happen now, {@code false} otherwise.
     *
     * @param numPackets    the number of packets that were written since the last flush.
     * @param numBytes      the number of bytes that were written since the last flush.
     * @return              {@code true} if a flush should be done now, {@code false} otherwise.
     */
    boolean shouldFlushNow(int numPackets, int numBytes);

    /**
     * Implementation that flushes after a number of bytes.
     *
     * @param bytes the number of bytes after which we should issue a flush.
     * @return the {@link FlushStrategy}.
     */
    static FlushStrategy afterNumBytes(int bytes) {
        ObjectUtil.checkPositive(bytes, "bytes");
        return (numPackets, numBytes) -> numBytes > bytes;
    }

    /**
     * Implementation that flushes after a number of packets.
     *
     * @param packets the number of packets after which we should issue a flush.
     * @return the {@link FlushStrategy}.
     */
    static FlushStrategy afterNumPackets(int packets) {
        ObjectUtil.checkPositive(packets, "packets");
        return (numPackets, numBytes) -> numPackets > packets;
    }
}