net.openhft.chronicle.bytes.ref

Class BinaryIntReference

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.bytes.ref.AbstractReference

net.openhft.chronicle.bytes.ref.BinaryIntReference

All Implemented Interfaces:

Closeable, AutoCloseable, Byteable, 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.IntValue

public class BinaryIntReference
extends AbstractReference
implements net.openhft.chronicle.core.values.IntValue

Holds a 32-bit integer in little-endian native order within a BytesStore.

Example usage:

 try (BinaryIntReference ref = new BinaryIntReference()) {
     ref.bytesStore(store, offset, ref.maxSize());
     ref.setValue(10);
 }
 

All volatile methods provide a full happens-before edge. Ordered methods use lazy set semantics. maxSize() always returns Integer.BYTES.

Negative values are valid; INT_NOT_COMPLETE is only a replay sentinel.

See Also:

BytesStore, IntValue

Field Summary

Fields

Modifier and Type	Field and Description
static int	INT_NOT_COMPLETE Sentinel value used when an integer operation fails to complete normally.

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
BinaryIntReference()

Method Summary

Modifier and Type	Method and Description
int	addAtomicValue(int delta) Adds a delta to the current 32-bit integer value atomically and returns the result.
int	addValue(int delta) Adds a delta to the current 32-bit integer value and returns the result.
void	bytesStore(@NotNull BytesStore bytes, long offset, long length) Sets the BytesStore which this reference points to.
boolean	compareAndSwapValue(int expected, int value) Atomically sets the 32-bit integer value to the given updated value if the current value is equal to the expected value.
int	getValue() Performs a plain read of the value from the backing store.
int	getVolatileValue() Retrieves the 32-bit integer value using volatile memory semantics.
long	maxSize() Returns the maximum size of this reference in bytes (4 bytes for a 32-bit integer).
void	setOrderedValue(int value) Sets the 32-bit integer value using ordered or lazy set memory semantics.
void	setValue(int value) Writes the value to the backing store using plain semantics.
@NotNull String	toString() Returns a string representation of this BinaryIntReference.

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.IntValue

close, isClosed

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.core.io.ReferenceOwner

referenceName, temporary

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

unmonitor

Field Detail

INT_NOT_COMPLETE

public static final int INT_NOT_COMPLETE

Sentinel value used when an integer operation fails to complete normally.

See Also:

Constant Field Values

Constructor Detail

BinaryIntReference

public BinaryIntReference()

Method Detail

bytesStore

public void bytesStore(@NotNull
                       @NotNull BytesStore bytes,
                       long offset,
                       long length)
                throws IllegalStateException,
                       IllegalArgumentException,
                       BufferOverflowException

Sets the BytesStore which this reference points to.

Specified by:

bytesStore in interface Byteable

Overrides:

bytesStore in class AbstractReference

Parameters:

bytes - the BytesStore

offset - the offset within the BytesStore

length - the length of the value

Throws:

IllegalArgumentException - If the length is not equal to maxSize

BufferOverflowException - If the offset is too large

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

maxSize

public long maxSize()

Returns the maximum size of this reference in bytes (4 bytes for a 32-bit integer).

Specified by:

maxSize in interface Byteable

Returns:

the maximum size in bytes

toString

@NotNull
public @NotNull String toString()

Returns a string representation of this BinaryIntReference.

Overrides:

toString in class net.openhft.chronicle.core.io.AbstractCloseable

Returns:

a string representation

getValue

public int getValue()
             throws IllegalStateException,
                    BufferUnderflowException

Performs a plain read of the value from the backing store.

Specified by:

getValue in interface net.openhft.chronicle.core.values.IntValue

Returns:

the current value

Throws:

BufferUnderflowException - if the offset is invalid

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

net.openhft.chronicle.core.io.ThreadingIllegalStateException - if accessed by multiple threads unsafely

IllegalStateException

setValue

public void setValue(int value)
              throws IllegalStateException,
                     BufferOverflowException

Writes the value to the backing store using plain semantics.

Specified by:

setValue in interface net.openhft.chronicle.core.values.IntValue

Parameters:

value - the value to store

Throws:

BufferOverflowException - if the offset is invalid

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

net.openhft.chronicle.core.io.ThreadingIllegalStateException - if accessed by multiple threads unsafely

IllegalStateException

getVolatileValue

public int getVolatileValue()
                     throws IllegalStateException,
                            BufferUnderflowException

Retrieves the 32-bit integer value using volatile memory semantics.

Specified by:

getVolatileValue in interface net.openhft.chronicle.core.values.IntValue

Returns:

the 32-bit integer value

Throws:

BufferUnderflowException - If the offset is too large

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

setOrderedValue

public void setOrderedValue(int value)
                     throws IllegalStateException,
                            BufferOverflowException

Sets the 32-bit integer value using ordered or lazy set memory semantics.

Specified by:

setOrderedValue in interface net.openhft.chronicle.core.values.IntValue

Parameters:

value - the 32-bit integer value to set

Throws:

BufferOverflowException - If the offset is too large

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

addValue

public int addValue(int delta)
             throws IllegalStateException,
                    BufferUnderflowException

Adds a delta to the current 32-bit integer value and returns the result.

Specified by:

addValue in interface net.openhft.chronicle.core.values.IntValue

Parameters:

delta - the value to add

Returns:

the resulting 32-bit integer value

Throws:

BufferUnderflowException - If the offset is too large

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

This atomic fetch-and-add forms a happens-before edge with subsequent reads of the value.

IllegalStateException

addAtomicValue

public int addAtomicValue(int delta)
                   throws IllegalStateException,
                          BufferUnderflowException

Adds a delta to the current 32-bit integer value atomically and returns the result.

Specified by:

addAtomicValue in interface net.openhft.chronicle.core.values.IntValue

Parameters:

delta - the value to add

Returns:

the resulting 32-bit integer value

Throws:

BufferUnderflowException - If the offset is too large

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

compareAndSwapValue

public boolean compareAndSwapValue(int expected,
                                   int value)
                            throws IllegalStateException,
                                   BufferOverflowException

Atomically sets the 32-bit integer value to the given updated value if the current value is equal to the expected value.

Specified by:

compareAndSwapValue in interface net.openhft.chronicle.core.values.IntValue

Parameters:

expected - the expected 32-bit integer value

value - the new 32-bit integer value

Returns:

true if successful, false otherwise

Throws:

BufferOverflowException - If the offset is too large

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

A successful swap establishes a happens-before relation with subsequent reads of the value.

IllegalStateException