net.openhft.chronicle.bytes.ref

Class BinaryTwoLongReference

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.bytes.ref.AbstractReference

net.openhft.chronicle.bytes.ref.BinaryLongReference

net.openhft.chronicle.bytes.ref.BinaryTwoLongReference

All Implemented Interfaces:

Closeable, AutoCloseable, Byteable, LongReference, TwoLongReference, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.Monitorable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner, net.openhft.chronicle.core.io.SingleThreadedChecked, net.openhft.chronicle.core.values.LongValue, net.openhft.chronicle.core.values.TwoLongValue

public class BinaryTwoLongReference
extends BinaryLongReference
implements TwoLongReference

Represents a binary reference containing two 64-bit long values.

This class extends BinaryLongReference and allows access to two 64-bit long values in a binary form, which are contiguous in memory.

Example usage:

 BytesStore bytesStore = BytesStore.nativeStoreWithFixedCapacity(16); // 16 bytes for two long values.
 BinaryTwoLongReference ref = new BinaryTwoLongReference();
 ref.bytesStore(bytesStore, 0, ref.maxSize());
 ref.setValue(1234567890L); // set the first long value
 ref.setValue2(9876543210L); // set the second long value
 

Note: This class is not thread-safe. External synchronization may be necessary if instances are shared between threads.

See Also:

BinaryLongReference

Field Summary

Fields inherited from class net.openhft.chronicle.bytes.ref.BinaryLongReference

LONG_NOT_COMPLETE

Fields inherited from class net.openhft.chronicle.bytes.ref.AbstractReference

bytesStore, offset

Fields inherited from class net.openhft.chronicle.core.io.AbstractCloseable

closedHere, DISABLE_DISCARD_WARNING, WARN_NS

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT, TMP

Fields inherited from interface net.openhft.chronicle.core.io.SingleThreadedChecked

DISABLE_SINGLE_THREADED_CHECK

Constructor Summary

Constructors

Constructor and Description
BinaryTwoLongReference()

Method Summary

Modifier and Type	Method and Description
long	addAtomicValue2(long delta) Atomically adds a delta to the second 64-bit long value and returns the result.
long	addValue2(long delta) Adds a delta to the second 64-bit long value and returns the result.
boolean	compareAndSwapValue2(long expected, long value) Atomically sets the second 64-bit long value to the given updated value if the current value is equal to the expected value.
long	getValue2() Gets the second long value from the BinaryTwoLongReference.
long	getVolatileValue2() Retrieves the second 64-bit long value using volatile memory semantics.
long	maxSize() Returns the maximum size of this reference in bytes (16 bytes for two 64-bit longs).
void	setOrderedValue2(long value) Sets the second 64-bit long value using ordered or lazy set memory semantics.
void	setValue2(long value) Sets the second 64-bit long value in the BytesStore.
void	setVolatileValue2(long value) Sets the second 64-bit long value using volatile memory semantics.
@NotNull String	toString() Returns a string representation of this BinaryTwoLongReference.

Methods inherited from class net.openhft.chronicle.bytes.ref.BinaryLongReference

addAtomicValue, addValue, bytesStore, compareAndSwapValue, getValue, getVolatileValue, setOrderedValue, setValue, setVolatileValue

Methods inherited from class net.openhft.chronicle.bytes.ref.AbstractReference

acceptNewBytesStore, address, bytesStore, lock, offset, performClose, tryLock, unmonitor

Methods inherited from class net.openhft.chronicle.core.io.AbstractCloseable

assertCloseable, assertCloseablesClosed, close, createdHere, disableCloseableTracing, enableCloseableTracing, gcAndWaitForCloseablesToClose, isClosed, isClosing, isInUserThread, referenceId, shouldPerformCloseInBackground, shouldWaitForClosed, singleThreadedCheckDisabled, singleThreadedCheckDisabled, singleThreadedCheckReset, threadSafetyCheck, throwExceptionIfClosed, throwExceptionIfClosedInSetter, waitForCloseablesToClose, waitForClosed, warnAndCloseIfNotClosed

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface net.openhft.chronicle.bytes.Byteable

address, bytesStore, bytesStore, lock, offset, tryLock

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

referenceName, temporary

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

unmonitor

Constructor Detail

BinaryTwoLongReference

public BinaryTwoLongReference()

Method Detail

maxSize

public long maxSize()

Returns the maximum size of this reference in bytes (16 bytes for two 64-bit longs).

Specified by:

maxSize in interface Byteable

Overrides:

maxSize in class BinaryLongReference

Returns:

the maximum size in bytes

toString

@NotNull
public @NotNull String toString()

Returns a string representation of this BinaryTwoLongReference.

Overrides:

toString in class BinaryLongReference

Returns:

a string representation

getValue2

public long getValue2()
               throws IllegalStateException

Gets the second long value from the BinaryTwoLongReference.

Specified by:

getValue2 in interface net.openhft.chronicle.core.values.TwoLongValue

Returns:

the second long value.

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setValue2

public void setValue2(long value)
               throws IllegalStateException

Sets the second 64-bit long value in the BytesStore.

Specified by:

setValue2 in interface net.openhft.chronicle.core.values.TwoLongValue

Parameters:

value - the second 64-bit long value to set

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

getVolatileValue2

public long getVolatileValue2()
                       throws IllegalStateException

Retrieves the second 64-bit long value using volatile memory semantics.

Specified by:

getVolatileValue2 in interface net.openhft.chronicle.core.values.TwoLongValue

Returns:

the second 64-bit long value

Throws:

IllegalStateException - If closed

setVolatileValue2

public void setVolatileValue2(long value)
                       throws IllegalStateException

Sets the second 64-bit long value using volatile memory semantics.

Specified by:

setVolatileValue2 in interface net.openhft.chronicle.core.values.TwoLongValue

Parameters:

value - the second 64-bit long value to set

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setOrderedValue2

public void setOrderedValue2(long value)
                      throws IllegalStateException

Sets the second 64-bit long value using ordered or lazy set memory semantics.

Specified by:

setOrderedValue2 in interface net.openhft.chronicle.core.values.TwoLongValue

Parameters:

value - the second 64-bit long value to set

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

addValue2

public long addValue2(long delta)
               throws IllegalStateException

Adds a delta to the second 64-bit long value and returns the result.

Specified by:

addValue2 in interface net.openhft.chronicle.core.values.TwoLongValue

Parameters:

delta - the value to add

Returns:

the resulting second 64-bit long value

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

addAtomicValue2

public long addAtomicValue2(long delta)
                     throws IllegalStateException

Atomically adds a delta to the second 64-bit long value and returns the result.

Specified by:

addAtomicValue2 in interface net.openhft.chronicle.core.values.TwoLongValue

Parameters:

delta - the value to add

Returns:

the resulting second 64-bit long value

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

compareAndSwapValue2

public boolean compareAndSwapValue2(long expected,
                                    long value)
                             throws IllegalStateException

Atomically sets the second 64-bit long value to the given updated value if the current value is equal to the expected value.

Specified by:

compareAndSwapValue2 in interface net.openhft.chronicle.core.values.TwoLongValue

Parameters:

expected - the expected second 64-bit long value

value - the new second 64-bit long value

Returns:

true if successful, false otherwise

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException