org.agrona.concurrent.status

Interface Position

All Superinterfaces:

java.lang.AutoCloseable, ReadablePosition

All Known Implementing Classes:

AtomicLongPosition, UnsafeBufferPosition

public interface Position
extends ReadablePosition

Reports on how far through a buffer some component has progressed. Threadsafe to write to from a single writer.

Method Summary

Modifier and Type	Method and Description
long	get() Get the current position of a component without memory ordering semantics.
boolean	isClosed() Has this Position been closed?
boolean	proposeMax(long proposedValue) Set the position to the new proposedValue if it is greater than the current proposedValue memory ordering semantics.
boolean	proposeMaxOrdered(long proposedValue) Set the position to the new proposedValue if it is greater than the current proposedValue with ordered atomic memory semantics.
void	set(long value) Sets the current position of the component without memory ordering semantics.
void	setOrdered(long value) Sets the current position of the component with ordered atomic memory semantics.

Methods inherited from interface org.agrona.concurrent.status.ReadablePosition

close, getVolatile, id

Method Detail

isClosed

boolean isClosed()

Has this Position been closed?

Returns:

true if this position has already been closed.

get

long get()

Get the current position of a component without memory ordering semantics.

Returns:

the current position of a component

set

void set(long value)

Sets the current position of the component without memory ordering semantics.

Parameters:

value - the current position of the component.

setOrdered

void setOrdered(long value)

Sets the current position of the component with ordered atomic memory semantics.

Parameters:

value - the current position of the component.

proposeMax

boolean proposeMax(long proposedValue)

Set the position to the new proposedValue if it is greater than the current proposedValue memory ordering semantics.

Parameters:

proposedValue - for the new max.

Returns:

true if a new max as been set otherwise false.

proposeMaxOrdered

boolean proposeMaxOrdered(long proposedValue)

Set the position to the new proposedValue if it is greater than the current proposedValue with ordered atomic memory semantics.

Parameters:

proposedValue - for the new max.

Returns:

true if a new max as been set otherwise false.