com.fluxtion.agrona.concurrent.status.ReadablePosition Maven / Gradle / Ivy

Go to download

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

There is a newer version: 9.4.4

/*
 * 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 com.fluxtion.agrona.concurrent.status;

/**
 * Indicates how far through an abstract task a component has progressed as a counter value.
 */
public abstract class ReadablePosition implements AutoCloseable
{
    /**
     * Identifier for this position.
     *
     * @return the identifier for this position.
     */
    public abstract int id();

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

    /**
     * {@inheritDoc}
     */
    public abstract void close();
}