org.agrona.concurrent.status

Class UnsafeBufferPosition

java.lang.Object

org.agrona.concurrent.status.ReadablePosition

org.agrona.concurrent.status.Position

org.agrona.concurrent.status.UnsafeBufferPosition

All Implemented Interfaces:

java.lang.AutoCloseable

public class UnsafeBufferPosition
extends Position

Reports a position by recording it in an UnsafeBuffer.

Constructor Summary

Constructors

Constructor and Description
UnsafeBufferPosition(UnsafeBuffer buffer, int counterId) Map a position over a buffer.
UnsafeBufferPosition(UnsafeBuffer buffer, int counterId, CountersManager countersManager) Map a position over a buffer and this indicator owns the counter for reclamation.

Method Summary

Modifier and Type	Method and Description
void	close()
long	get() Get the current position of a component without memory ordering semantics.
long	getVolatile() Get the current position of a component with volatile semantics
int	id() Identifier for this position.
boolean	isClosed() Has this Position been closed?
boolean	proposeMax(long proposedValue) Set the position to a new proposedValue if greater than the current value without memory ordering semantics.
boolean	proposeMaxOrdered(long proposedValue) Set the position to the new proposedValue if greater than the current value with memory ordering 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 memory semantics.
void	setVolatile(long value) Sets the current position of the component with volatile memory semantics.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnsafeBufferPosition

public UnsafeBufferPosition(UnsafeBuffer buffer,
                            int counterId)

Map a position over a buffer.

Parameters:

buffer - containing the counter.

counterId - identifier of the counter.

UnsafeBufferPosition

public UnsafeBufferPosition(UnsafeBuffer buffer,
                            int counterId,
                            CountersManager countersManager)

Map a position over a buffer and this indicator owns the counter for reclamation.

Parameters:

buffer - containing the counter.

counterId - identifier of the counter.

countersManager - to be used for freeing the counter when this is closed.

Method Detail

isClosed

public boolean isClosed()

Description copied from class: Position

Has this Position been closed?

Specified by:

isClosed in class Position

Returns:

true if this position has already been closed.

id

public int id()

Description copied from class: ReadablePosition

Identifier for this position.

Specified by:

id in class ReadablePosition

Returns:

the identifier for this position.

get

public long get()

Description copied from class: Position

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

Specified by:

get in class Position

Returns:

the current position of a component

getVolatile

public long getVolatile()

Description copied from class: ReadablePosition

Get the current position of a component with volatile semantics

Specified by:

getVolatile in class ReadablePosition

Returns:

the current position of a component with volatile semantics

set

public void set(long value)

Description copied from class: Position

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

Specified by:

set in class Position

Parameters:

value - the current position of the component.

setOrdered

public void setOrdered(long value)

Description copied from class: Position

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

Specified by:

setOrdered in class Position

Parameters:

value - the current position of the component.

setVolatile

public void setVolatile(long value)

Description copied from class: Position

Sets the current position of the component with volatile memory semantics.

Specified by:

setVolatile in class Position

Parameters:

value - the current position of the component.

proposeMax

public boolean proposeMax(long proposedValue)

Description copied from class: Position

Set the position to a new proposedValue if greater than the current value without memory ordering semantics.

Specified by:

proposeMax in class Position

Parameters:

proposedValue - for the new max.

Returns:

true if a new max as been set otherwise false.

proposeMaxOrdered

public boolean proposeMaxOrdered(long proposedValue)

Description copied from class: Position

Set the position to the new proposedValue if greater than the current value with memory ordering semantics.

Specified by:

proposeMaxOrdered in class Position

Parameters:

proposedValue - for the new max.

Returns:

true if a new max as been set otherwise false.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class ReadablePosition