io.aeron.driver.TerminationValidator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aeron-driver 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;

import org.agrona.DirectBuffer;

import java.io.File;

/**
 * Validate if the driver should terminate based on the provided token.
 */
@FunctionalInterface
public interface TerminationValidator
{
    /**
     * Should the given termination request be considered valid or not.
     *
     * @param aeronDir    of the driver.
     * @param tokenBuffer of the token in the request.
     * @param tokenOffset of the token within the buffer.
     * @param tokenLength of the token within the buffer.
     * @return true if request is to be considered valid and the driver termination hook should be run or false if not.
     */
    boolean allowTermination(File aeronDir, DirectBuffer tokenBuffer, int tokenOffset, int tokenLength);
}