org.agrona.concurrent.status.Position Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of Agrona Show documentation
Show all versions of Agrona Show documentation
High performance primitives and utility library.
/*
* Copyright 2014 - 2016 Real Logic Ltd.
*
* 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
*
* http://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;
/**
* Reports on how far through a buffer some component has progressed.
*
* Threadsafe to write to from a single writer.
*/
public interface Position extends ReadablePosition
{
/**
* Get the current position of a component without memory ordering semantics.
*
* @return the current position of a component
*/
long get();
/**
* Sets the current position of the component without memory ordering semantics.
*
* @param value the current position of the component.
*/
void set(long value);
/**
* Sets the current position of the component with ordered atomic memory semantics.
*
* @param value the current position of the component.
*/
void setOrdered(long value);
/**
* Set the position to the new proposedValue if it is greater than the current proposedValue memory ordering semantics.
*
* @param proposedValue for the new max.
* @return true if a new max as been set otherwise false.
*/
boolean proposeMax(long proposedValue);
/**
* Set the position to the new proposedValue if it is greater than the current proposedValue with ordered atomic
* memory semantics.
*
* @param proposedValue for the new max.
* @return true if a new max as been set otherwise false.
*/
boolean proposeMaxOrdered(long proposedValue);
}