net.openhft.chronicle.core.io

Class UnsafeCloseable

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.core.io.UnsafeCloseable

All Implemented Interfaces:

Closeable, AutoCloseable, ManagedCloseable, Monitorable, QueryCloseable, ReferenceOwner, SingleThreadedChecked

public abstract class UnsafeCloseable
extends AbstractCloseable

Convenience base for memory backed resources using Unsafe. Not thread-safe. The memory address is set via address(long) and the clean-up is performed in performClose().

Field Summary

Fields

Modifier and Type	Field and Description
protected long	address
protected sun.misc.Unsafe	unsafe

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

Modifier	Constructor and Description
protected	UnsafeCloseable() Disable the single-threaded check because these resources are typically accessed from multiple threads.

Method Summary

Modifier and Type	Method and Description
long	addAtomicLong(long delta) Adds the specified value to the long value stored at the memory address and returns the updated value.
long	addLong(long delta) Adds the specified value to the long value stored at the memory address and returns the updated value.
protected void	address(long address) Assign the backing memory address.
boolean	compareAndSwapLong(long expected, long value) Compares the value at the memory address with the expected value and, if they match, sets the value to a new value.
long	getLong() Gets the long value stored at the memory address.
long	getVolatileLong() Gets the volatile long value stored at the memory address.
long	getVolatileLong(long closedLong) Gets the volatile long value stored at the memory address, or a default value if the resource is closed.
protected void	performClose() Implement the clean-up logic.
void	setLong(long value) Sets the long value at the memory address.
void	setOrderedLong(long value) Sets the ordered long value at the memory address.
void	setVolatileLong(long value) Sets the volatile long value at the memory address.

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, toString, unmonitor, 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.io.ReferenceOwner

referenceName, temporary

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

closeQuietly, closeQuietly

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

unmonitor

Field Detail

address

protected long address

unsafe

protected sun.misc.Unsafe unsafe

Constructor Detail

UnsafeCloseable

protected UnsafeCloseable()

Disable the single-threaded check because these resources are typically accessed from multiple threads.

Method Detail

address

protected void address(long address)

Assign the backing memory address.

performClose

protected void performClose()
                     throws IllegalStateException

Description copied from class: AbstractCloseable

Implement the clean-up logic. close() invokes this method exactly once via AbstractCloseable.callPerformClose().

Specified by:

performClose in class AbstractCloseable

Throws:

IllegalStateException

getLong

public long getLong()
             throws ClosedIllegalStateException,
                    ThreadingIllegalStateException

Gets the long value stored at the memory address.

Returns:

The long value.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If used in a non thread safe way

setLong

public void setLong(long value)
             throws ClosedIllegalStateException,
                    ThreadingIllegalStateException

Sets the long value at the memory address.

Parameters:

value - The long value to set.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If used in a non thread safe way

getVolatileLong

public long getVolatileLong()
                     throws ClosedIllegalStateException,
                            ThreadingIllegalStateException

Gets the volatile long value stored at the memory address.

Returns:

The volatile long value.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If used in a non thread safe way

setVolatileLong

public void setVolatileLong(long value)
                     throws ClosedIllegalStateException,
                            ThreadingIllegalStateException

Sets the volatile long value at the memory address.

Parameters:

value - The volatile long value to set.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If used in a non thread safe way

getVolatileLong

public long getVolatileLong(long closedLong)
                     throws ClosedIllegalStateException

Gets the volatile long value stored at the memory address, or a default value if the resource is closed.

Parameters:

closedLong - The default value to return if the resource is closed.

Returns:

The volatile long value or the default value if closed.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If used in a non thread safe way

setOrderedLong

public void setOrderedLong(long value)
                    throws ClosedIllegalStateException,
                           ThreadingIllegalStateException

Sets the ordered long value at the memory address.

Parameters:

value - The ordered long value to set.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If used in a non thread safe way

addLong

public long addLong(long delta)
             throws ClosedIllegalStateException,
                    ThreadingIllegalStateException

Adds the specified value to the long value stored at the memory address and returns the updated value.

Parameters:

delta - The value to add.

Returns:

The updated value.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If used in a non thread safe way

addAtomicLong

public long addAtomicLong(long delta)
                   throws ClosedIllegalStateException,
                          ThreadingIllegalStateException

Adds the specified value to the long value stored at the memory address and returns the updated value. This method is equivalent to addLong(long).

Parameters:

delta - The value to add.

Returns:

The updated value.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If used in a non thread safe way

compareAndSwapLong

public boolean compareAndSwapLong(long expected,
                                  long value)
                           throws ClosedIllegalStateException,
                                  ThreadingIllegalStateException

Compares the value at the memory address with the expected value and, if they match, sets the value to a new value.

Parameters:

expected - The expected value.

value - The new value to set.

Returns:

true if the swap was successful, false otherwise.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If used in a non thread safe way