net.openhft.chronicle.bytes.ref

Class AbstractReference

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.bytes.ref.AbstractReference

All Implemented Interfaces:

Closeable, AutoCloseable, Byteable, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner, net.openhft.chronicle.core.io.SingleThreadedChecked

Direct Known Subclasses:

BinaryBooleanReference, BinaryIntArrayReference, BinaryIntReference, BinaryLongArrayReference, BinaryLongReference, TextBooleanReference, TextIntArrayReference, TextIntReference, TextLongArrayReference, TextLongReference

public abstract class AbstractReference
extends net.openhft.chronicle.core.io.AbstractCloseable
implements Byteable, net.openhft.chronicle.core.io.Closeable

Represents an abstract reference to a BytesStore.

This class provides an abstraction for managing a reference to a BytesStore. It provides functionality to read and write data from/to the BytesStore, manage a reference count, and lock resources.

See Also:

BytesStore, Byteable, Closeable

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable BytesStore<?,?>	bytes BytesStore associated with this reference
protected long	offset Offset within the BytesStore for this reference

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

closedHere, DISABLE_DISCARD_WARNING, DISABLE_THREAD_SAFETY, STRICT_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	AbstractReference() Constructor initializes the reference assuming thread safety.

Method Summary

Modifier and Type	Method and Description
protected void	acceptNewBytesStore(@NotNull BytesStore bytes) Updates the BytesStore for this reference, releasing any previous BytesStore
long	address() Retrieves the memory address for reading.
@Nullable BytesStore	bytesStore() Returns the ByteStore to which this object currently points.
void	bytesStore(@NotNull BytesStore bytes, long offset, long length) Sets the underlying BytesStore to work with, along with the offset and length.
FileLock	lock(boolean shared) Attempts to lock a region in the file in either shared or exclusive mode.
long	offset() Returns the offset within the ByteStore to which this object currently points.
protected void	performClose() Closes this reference, releasing any associated BytesStore
FileLock	tryLock(boolean shared) Attempts to lock a region in the file in either shared or exclusive mode, but does not block waiting for the lock.

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

assertCloseable, assertCloseablesClosed, clearUsedByThread, close, createdHere, disableCloseableTracing, disableThreadSafetyCheck, disableThreadSafetyCheck, enableCloseableTracing, gcAndWaitForCloseablesToClose, isClosed, isClosing, isInUserThread, referenceId, resetUsedByThread, 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.bytes.Byteable

maxSize

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

close, closeQuietly, closeQuietly

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

isClosed, isClosing

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

referenceName, temporary

Field Detail

bytes

@Nullable
protected @Nullable BytesStore<?,?> bytes

BytesStore associated with this reference

offset

protected long offset

Offset within the BytesStore for this reference

Constructor Detail

AbstractReference

protected AbstractReference()

Constructor initializes the reference assuming thread safety.

Method Detail

bytesStore

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

Sets the underlying BytesStore to work with, along with the offset and length.

Specified by:

bytesStore in interface Byteable

Parameters:

bytes - the BytesStore to set

offset - the offset to set

length - the length to set

Throws:

IllegalStateException - if the state is invalid

IllegalArgumentException - if the arguments are invalid

BufferOverflowException - if the provided buffer is too small

bytesStore

@Nullable
public @Nullable BytesStore bytesStore()

Description copied from interface: Byteable

Returns the ByteStore to which this object currently points.

Specified by:

bytesStore in interface Byteable

Returns:

the BytesStore associated with this reference

offset

public long offset()

Description copied from interface: Byteable

Returns the offset within the ByteStore to which this object currently points.

Specified by:

offset in interface Byteable

Returns:

the offset within the BytesStore for this reference

acceptNewBytesStore

protected void acceptNewBytesStore(@NotNull
                                   @NotNull BytesStore bytes)
                            throws IllegalStateException

Updates the BytesStore for this reference, releasing any previous BytesStore

Parameters:

bytes - the new BytesStore

Throws:

IllegalStateException - if this reference has been closed

performClose

protected void performClose()

Closes this reference, releasing any associated BytesStore

Specified by:

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

address

public long address()
             throws IllegalStateException,
                    BufferUnderflowException

Retrieves the memory address for reading.

Specified by:

address in interface Byteable

Returns:

the memory address

Throws:

IllegalStateException - if the state is invalid

BufferUnderflowException - if the buffer does not have enough content

lock

public FileLock lock(boolean shared)
              throws IOException

Attempts to lock a region in the file in either shared or exclusive mode.

Specified by:

lock in interface Byteable

Parameters:

shared - if true the lock will be shared, otherwise it will be exclusive.

Returns:

a FileLock object representing the locked region

Throws:

IOException - if an I/O error occurs

tryLock

public FileLock tryLock(boolean shared)
                 throws IOException

Attempts to lock a region in the file in either shared or exclusive mode, but does not block waiting for the lock.

Specified by:

tryLock in interface Byteable

Parameters:

shared - if true the lock will be shared, otherwise it will be exclusive.

Returns:

a FileLock object representing the locked region or null if the lock could not be acquired

Throws:

IOException - if an I/O error occurs