io.aeron.driver.ext.LossGenerator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aeron-all Show documentation

Efficient reliable UDP unicast, UDP multicast, and IPC transport protocol.

There is a newer version: 1.48.0

/*
 * Copyright 2014-2024 Real Logic Limited.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.aeron.driver.ext;

import org.agrona.concurrent.UnsafeBuffer;

import java.net.InetSocketAddress;

/**
 * Interface for loss generators.
 */
@FunctionalInterface
public interface LossGenerator
{
    /**
     * Should a frame be dropped?
     *
     * @param address The source address of the frame if inbound or the remote address if outbound.
     * @param buffer  The buffer containing the frame data.
     * @param length  The length of the frame.
     * @return true to drop, false to process
     */
    boolean shouldDropFrame(InetSocketAddress address, UnsafeBuffer buffer, int length);

    /**
     * Should a frame be dropped?
     *
     * @param address    The source address of the frame if inbound or the remote address if outbound.
     * @param buffer     The buffer containing the frame data.
     * @param streamId   of the incoming frame.
     * @param sessionId  of the incoming frame
     * @param termId     of the incoming frame.
     * @param termOffset of the incoming frame.
     * @param length     of the incoming frame.
     * @return true to drop, false to process
     */
    default boolean shouldDropFrame(
        InetSocketAddress address,
        UnsafeBuffer buffer,
        final int streamId,
        final int sessionId,
        int termId,
        int termOffset,
        int length)
    {
        return shouldDropFrame(address, buffer, length);
    }
}