org.agrona.concurrent

Interface AtomicBuffer

All Superinterfaces:

Comparable<DirectBuffer>, DirectBuffer, MutableDirectBuffer

All Known Implementing Classes:

UnsafeBuffer

public interface AtomicBuffer
extends MutableDirectBuffer

Abstraction over a range of buffer types that allows type to be accessed with memory ordering semantics.

Field Summary

Fields inherited from interface org.agrona.DirectBuffer

DISABLE_ARRAY_CONTENT_PRINTOUT_PROP_NAME, STR_HEADER_LEN

Method Summary

Modifier and Type	Method and Description
int	addIntOrdered(int index, int increment) Add a value to a given index with ordered store semantics.
long	addLongOrdered(int index, long increment) Add a value to a given index with ordered store semantics.
boolean	compareAndSetInt(int index, int expectedValue, int updateValue) Atomic compare and set of an int given an expected value.
boolean	compareAndSetLong(int index, long expectedValue, long updateValue) Atomic compare and set of a long given an expected value.
int	getAndAddInt(int index, int delta) Atomically add a delta to a value at a location returning the previous contents.
long	getAndAddLong(int index, long delta) Atomically add a delta to a value at a location returning the previous contents.
int	getAndSetInt(int index, int value) Atomically exchange a value at a location returning the previous contents.
long	getAndSetLong(int index, long value) Atomically exchange a value at a location returning the previous contents.
byte	getByteVolatile(int index) Get the value at a given index with volatile semantics.
char	getCharVolatile(int index) Get the value at a given index with volatile semantics.
int	getIntVolatile(int index) Get the value at a given index with volatile semantics.
long	getLongVolatile(int index) Get the value at a given index with volatile semantics.
short	getShortVolatile(int index) Get the value at a given index with volatile semantics.
void	putByteVolatile(int index, byte value) Put a value to a given index with volatile semantics.
void	putCharVolatile(int index, char value) Put a value to a given index with volatile semantics.
void	putIntOrdered(int index, int value) Put a value to a given index with ordered semantics.
void	putIntVolatile(int index, int value) Put a value to a given index with volatile semantics.
void	putLongOrdered(int index, long value) Put a value to a given index with ordered store semantics.
void	putLongVolatile(int index, long value) Put a value to a given index with volatile semantics.
void	putShortVolatile(int index, short value) Put a value to a given index with volatile semantics.
void	verifyAlignment() Verify that the underlying buffer is correctly aligned to prevent word tearing and other ordering issues.

Methods inherited from interface org.agrona.MutableDirectBuffer

isExpandable, putByte, putBytes, putBytes, putBytes, putBytes, putBytes, putChar, putChar, putDouble, putDouble, putFloat, putFloat, putInt, putInt, putIntAscii, putLong, putLong, putLongAscii, putNaturalIntAscii, putNaturalIntAsciiFromEnd, putNaturalLongAscii, putNaturalPaddedIntAscii, putShort, putShort, putStringAscii, putStringAscii, putStringAscii, putStringAscii, putStringUtf8, putStringUtf8, putStringUtf8, putStringUtf8, putStringWithoutLengthAscii, putStringWithoutLengthAscii, putStringWithoutLengthAscii, putStringWithoutLengthAscii, putStringWithoutLengthUtf8, setMemory

Methods inherited from interface org.agrona.DirectBuffer

addressOffset, boundsCheck, byteArray, byteBuffer, capacity, checkLimit, getByte, getBytes, getBytes, getBytes, getBytes, getBytes, getChar, getChar, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getShort, getShort, getStringAscii, getStringAscii, getStringAscii, getStringAscii, getStringAscii, getStringAscii, getStringUtf8, getStringUtf8, getStringUtf8, getStringWithoutLengthAscii, getStringWithoutLengthAscii, getStringWithoutLengthUtf8, parseIntAscii, parseLongAscii, parseNaturalIntAscii, parseNaturalLongAscii, wrap, wrap, wrap, wrap, wrap, wrap, wrap, wrapAdjustment

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

verifyAlignment

void verifyAlignment()

Verify that the underlying buffer is correctly aligned to prevent word tearing and other ordering issues.

Throws:

IllegalStateException - if the alignment is not correct.

getLongVolatile

long getLongVolatile(int index)

Get the value at a given index with volatile semantics.

Parameters:

index - in bytes from which to get.

Returns:

the value for at a given index.

putLongVolatile

void putLongVolatile(int index,
                     long value)

Put a value to a given index with volatile semantics.

Parameters:

index - in bytes for where to put.

value - for at a given index.

putLongOrdered

void putLongOrdered(int index,
                    long value)

Put a value to a given index with ordered store semantics.

Parameters:

index - in bytes for where to put.

value - for at a given index.

addLongOrdered

long addLongOrdered(int index,
                    long increment)

Add a value to a given index with ordered store semantics. Use a negative increment to decrement.

Parameters:

index - in bytes for where to put.

increment - by which the value at the index will be adjusted.

Returns:

the previous value at the index.

compareAndSetLong

boolean compareAndSetLong(int index,
                          long expectedValue,
                          long updateValue)

Atomic compare and set of a long given an expected value.

Parameters:

index - in bytes for where to put.

expectedValue - at to be compared.

updateValue - to be exchanged.

Returns:

set successful or not.

getAndSetLong

long getAndSetLong(int index,
                   long value)

Atomically exchange a value at a location returning the previous contents.

Parameters:

index - in bytes for where to put.

value - for at a given index.

Returns:

previous value at the index.

getAndAddLong

long getAndAddLong(int index,
                   long delta)

Atomically add a delta to a value at a location returning the previous contents. To decrement a negative delta can be provided.

Parameters:

index - in bytes for where to put.

delta - to be added to the value at the index.

Returns:

previous value.

getIntVolatile

int getIntVolatile(int index)

Get the value at a given index with volatile semantics.

Parameters:

index - in bytes from which to get.

Returns:

the value for at a given index.

putIntVolatile

void putIntVolatile(int index,
                    int value)

Put a value to a given index with volatile semantics.

Parameters:

index - in bytes for where to put.

value - for at a given index.

putIntOrdered

void putIntOrdered(int index,
                   int value)

Put a value to a given index with ordered semantics.

Parameters:

index - in bytes for where to put.

value - for at a given index.

addIntOrdered

int addIntOrdered(int index,
                  int increment)

Add a value to a given index with ordered store semantics. Use a negative increment to decrement.

Parameters:

index - in bytes for where to put.

increment - by which the value at the index will be adjusted.

Returns:

the previous value at the index.

compareAndSetInt

boolean compareAndSetInt(int index,
                         int expectedValue,
                         int updateValue)

Atomic compare and set of an int given an expected value.

Parameters:

index - in bytes for where to put.

expectedValue - at to be compared.

updateValue - to be exchanged.

Returns:

successful or not.

getAndSetInt

int getAndSetInt(int index,
                 int value)

Atomically exchange a value at a location returning the previous contents.

Parameters:

index - in bytes for where to put.

value - for at a given index.

Returns:

previous value.

getAndAddInt

int getAndAddInt(int index,
                 int delta)

Atomically add a delta to a value at a location returning the previous contents. To decrement a negative delta can be provided.

Parameters:

index - in bytes for where to put.

delta - to be added to the value at the index.

Returns:

previous value.

getShortVolatile

short getShortVolatile(int index)

Get the value at a given index with volatile semantics.

Parameters:

index - in bytes from which to get.

Returns:

the value for at a given index.

putShortVolatile

void putShortVolatile(int index,
                      short value)

Put a value to a given index with volatile semantics.

Parameters:

index - in bytes for where to put.

value - for at a given index.

getCharVolatile

char getCharVolatile(int index)

Get the value at a given index with volatile semantics.

Parameters:

index - in bytes from which to get.

Returns:

the value for at a given index.

putCharVolatile

void putCharVolatile(int index,
                     char value)

Put a value to a given index with volatile semantics.

Parameters:

index - in bytes for where to put.

value - for at a given index.

getByteVolatile

byte getByteVolatile(int index)

Get the value at a given index with volatile semantics.

Parameters:

index - in bytes from which to get.

Returns:

the value for at a given index.

putByteVolatile

void putByteVolatile(int index,
                     byte value)

Put a value to a given index with volatile semantics.

Parameters:

index - in bytes for where to put.

value - for at a given index.