net.openhft.chronicle.core.values

Interface TwoLongValue

All Superinterfaces:

AutoCloseable, Closeable, LongValue, QueryCloseable

public interface TwoLongValue
extends LongValue

Represents a container for two long values, providing mechanisms for getting, setting, and manipulating them with various memory ordering effects.

This interface extends LongValue, which provides the base functionality for a single long value. This interface adds support for a second long value.

Concrete implementations are responsible for managing the storage and retrieval mechanisms of these long values.

Notable methods of this interface include:

• getValue2() - Retrieves the second long value.
• setValue2(long) - Sets the second long value.
• getVolatileValue2() - Retrieves the second long value with volatile semantics.
• setVolatileValue2(long) - Sets the second long value with volatile semantics.
• addValue2(long) - Atomically adds the given amount to the second long value.
• compareAndSwapValue2(long, long) - Atomically sets the second long value if it is equal to the expected value.

Additionally, the interface provides default implementations for setting the second value to the maximum or minimum of the current value and a specified value, and for atomically setting and retrieving both values.

Implementations can also include additional behaviors or optimizations not specified in this interface.

Since:

10/10/13

Author:

Peter Lawrey

See Also:

LongValue, BooleanValue, ByteValue, CharValue, DoubleValue, FloatValue, IntValue, LongValue, ShortValue, StringValue, LongArrayValues, IntArrayValues, UnsetLongValue

Method Summary

Modifier and Type	Method and Description
long	addAtomicValue2(long delta) Atomically adds the specified value to the second long value.
long	addValue2(long delta) Adds the specified value to the second long value and returns the result.
boolean	compareAndSwapValue2(long expected, long value) Atomically compares the current second long value with the expected value, and if they match, updates the second value to the specified new value.
long	getValue2() Retrieves the second long value.
default void	getValues(long[] values) Deprecated.
long	getVolatileValue2() Retrieves the second long value using volatile semantics.
default void	setMaxValue2(long value) Deprecated.
default void	setMinValue2(long value) Deprecated.
void	setOrderedValue2(long value) Sets the second long value using ordered semantics.
void	setValue2(long value2) Sets the second long value.
default void	setValues(long value1, long value2) Deprecated.
void	setVolatileValue2(long value) Sets the second long value using volatile semantics.

Methods inherited from interface net.openhft.chronicle.core.values.LongValue

addAtomicValue, addValue, close, compareAndSwapValue, getValue, getVolatileValue, getVolatileValue, isClosed, setMaxValue, setMinValue, setOrderedValue, setValue, setVolatileValue

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

closeQuietly, closeQuietly

Methods inherited from interface net.openhft.chronicle.core.io.QueryCloseable

isClosing

Method Detail

getValue2

long getValue2()
        throws IllegalStateException

Retrieves the second long value.

Returns:

The second long value.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setValue2

void setValue2(long value2)
        throws IllegalStateException

Sets the second long value.

Parameters:

value2 - The value to set.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

getVolatileValue2

long getVolatileValue2()
                throws IllegalStateException

Retrieves the second long value using volatile semantics. Ensures that subsequent reads and writes are not reordered beyond this point.

Returns:

The second long value.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setVolatileValue2

void setVolatileValue2(long value)
                throws IllegalStateException

Sets the second long value using volatile semantics. Ensures that subsequent reads and writes are not reordered beyond this point.

Parameters:

value - The value to set.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setOrderedValue2

void setOrderedValue2(long value)
               throws IllegalStateException

Sets the second long value using ordered semantics. Ensures that previous writes are not reordered beyond this point.

Parameters:

value - The value to set.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

addValue2

long addValue2(long delta)
        throws IllegalStateException

Adds the specified value to the second long value and returns the result.

Parameters:

delta - The value to add.

Returns:

The result after addition.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

addAtomicValue2

long addAtomicValue2(long delta)
              throws IllegalStateException

Atomically adds the specified value to the second long value. Ensures that the operation is done atomically and is visible to all threads.

Parameters:

delta - The value to add.

Returns:

The result after the addition.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

compareAndSwapValue2

boolean compareAndSwapValue2(long expected,
                             long value)
                      throws IllegalStateException

Atomically compares the current second long value with the expected value, and if they match, updates the second value to the specified new value.

Parameters:

expected - The expected value.

value - The new value.

Returns:

true if the swap was successful, otherwise false.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setMaxValue2

@Deprecated
default void setMaxValue2(long value)
                               throws IllegalStateException

Deprecated.

Sets the second long value to the maximum of the current value and the specified value.

Parameters:

value - The value to compare.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setMinValue2

@Deprecated
default void setMinValue2(long value)
                               throws IllegalStateException

Deprecated.

Sets the second long value to the minimum of the current value and the specified value.

Parameters:

value - The value to compare.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setValues

@Deprecated
default void setValues(long value1,
                                   long value2)
                            throws IllegalStateException

Deprecated.

Atomically sets both long values.

Parameters:

value1 - The first value to set.

value2 - The second value to set.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

getValues

@Deprecated
default void getValues(long[] values)
                            throws IllegalStateException

Deprecated.

Retrieves both long values atomically.

Parameters:

values - An array where the values will be stored. The first value is stored at index 0, and the second value is stored at index 1.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException