io.aeron.AvailableCounterHandler Maven / Gradle / Ivy

Go to download

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

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

There is a newer version: 1.46.2

/*
 * 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;

import org.agrona.concurrent.status.CountersReader;

/**
 * Interface for notification of{@link Counter}s becoming available via a {@link Aeron} client.
 */
@FunctionalInterface
public interface AvailableCounterHandler
{
    /**
     * Method called by Aeron to deliver notification of a {@link Counter} being available.
     * 
     * Within this callback reentrant calls to the {@link Aeron} client are not permitted and
     * will result in undefined behaviour.
     *
     * @param countersReader for more detail on the counter.
     * @param registrationId for the counter.
     * @param counterId      that is available.
     */
    void onAvailableCounter(CountersReader countersReader, long registrationId, int counterId);
}