org.agrona.concurrent.status.StatusIndicatorReader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of agrona Show documentation

High performance primitives and utility library.

The newest version!

/*
 * Copyright 2014-2025 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 org.agrona.concurrent.status;

/**
 * Reads the value of a counter to indicate current status and what abstraction should be taken.
 * @see CountersReader
 */
public abstract class StatusIndicatorReader
{
    /**
     * Default constructor.
     */
    public StatusIndicatorReader()
    {
    }

    /**
     * Identifier for this status indicator.
     *
     * @return the identifier for this status indicator.
     */
    public abstract int id();

    /**
     * Get the current status indication of a component with volatile semantics.
     *
     * @return the current status indication of a component with volatile semantics.
     */
    public abstract long getVolatile();
}