net.openhft.chronicle.bytes

Class MappedBytesStore

java.lang.Object

net.openhft.chronicle.core.io.AbstractReferenceCounted

net.openhft.chronicle.bytes.internal.AbstractBytesStore<net.openhft.chronicle.bytes.internal.NativeBytesStore<U>,U>

net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

net.openhft.chronicle.bytes.MappedBytesStore

All Implemented Interfaces:

CharSequence, BytesStore<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>,Void>, RandomCommon, RandomDataInput, RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>, net.openhft.chronicle.core.io.Monitorable, net.openhft.chronicle.core.io.ReferenceCounted, net.openhft.chronicle.core.io.ReferenceCountedTracer, net.openhft.chronicle.core.io.ReferenceOwner, net.openhft.chronicle.core.io.SingleThreadedChecked

public class MappedBytesStore
extends net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

NativeBytesStore backed by a region of a memory-mapped file.

Direct access methods assume the caller performs bounds checking; misuse can corrupt memory.

Field Summary

Fields

Modifier and Type	Field and Description
protected Runnable	writeCheck run before each write, throws if read only

Fields inherited from class net.openhft.chronicle.bytes.internal.NativeBytesStore

address, limit, maximumLimit, memory

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

referenceCounted, WARN_COUNT, 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	MappedBytesStore(net.openhft.chronicle.core.io.ReferenceOwner owner, MappedFile mappedFile, long start, long address, long capacity, long safeCapacity, int pageSize) Constructs a MappedBytesStore for a mapped region.

Method Summary

Modifier and Type	Method and Description
long	appendUtf8(long pos, char[] chars, int offset, int length)
@NotNull Bytes<Void>	bytesForRead() Returns a Bytes that wraps this ByteStore from the start to the realCapacity.
@NotNull VanillaBytes<Void>	bytesForWrite() Returns a Bytes that wraps this ByteStore from the start to the realCapacity.
boolean	compareAndSwapInt(long offset, int expected, int value) Performs a 32-bit compare-and-swap (CAS) operation at a given offset.
boolean	compareAndSwapLong(long offset, long expected, long value) Performs a 64-bit compare-and-swap (CAS) operation at a given offset.
static MappedBytesStore	create(net.openhft.chronicle.core.io.ReferenceOwner owner, MappedFile mappedFile, long start, long address, long capacity, long safeCapacity, int pageSize) Factory method mirroring the protected constructor.
boolean	inside(long offset) Returns true if the given offset lies within this mapping's safe range.
boolean	inside(long offset, long bufferSize) Same as inside(long) but also checks the end of the supplied range.
FileLock	lock(long position, long size, boolean shared) Acquires a lock on a region of the underlying file.
void	nativeWrite(long address, long position, long size) Expert-level method that copies data directly from native memory into this BytesStore.
protected void	performRelease() Syncs the mapped region to disk prior to release if required.
byte	readByte(long offset) Reads a byte value from a specific offset.
long	readPosition() /**
long	safeLimit()
long	start()
SyncMode	syncMode()
void	syncMode(SyncMode syncMode) Set the sync mode for this ByteStore
void	syncUpTo(long position) Synchronise from the last complete page up to this position.
void	syncUpTo(long position, SyncMode syncMode) Synchronise from the last complete page up to this position.
long	translate(long offset) Converts a logical offset in the file into an offset relative to this mapped region.
FileLock	tryLock(long position, long size, boolean shared) Attempts to acquire a lock on a region of the underlying file.
long	underlyingCapacity()
@NotNull MappedBytesStore	write(long offsetInRDO, byte[] byteArray, int offset, int length) Copies the provided byteArray to this Bytes object starting at writeOffset taking content starting at readOffset but copying at most length bytes.
void	write(long offsetInRDO, @NotNull ByteBuffer bytes, int offset, int length) Copies a segment from the provided ByteBuffer into this data output.
@NotNull MappedBytesStore	write(long writeOffset, @NotNull RandomDataInput bytes, long readOffset, long length) Copies a segment from the provided RandomDataInput into this data output.
void	write0(long offsetInRDO, @NotNull RandomDataInput bytes, long offset, long length)
@NotNull MappedBytesStore	writeByte(long offset, byte i8) Writes a byte at the specified non-negative offset.
@NotNull MappedBytesStore	writeDouble(long offset, double d) Writes a double-precision floating-point value at the specified non-negative offset.
@NotNull MappedBytesStore	writeFloat(long offset, float f) Writes a single-precision floating-point value at the specified non-negative offset.
@NotNull MappedBytesStore	writeInt(long offset, int i32) Writes an integer value at the specified non-negative offset.
@NotNull MappedBytesStore	writeLong(long offset, long i64) Writes a long integer value at the specified non-negative offset.
@NotNull MappedBytesStore	writeOrderedInt(long offset, int i) Performs a non-blocking write operation with a memory barrier to ensure order of stores.
@NotNull MappedBytesStore	writeOrderedLong(long offset, long i) Performs a non-blocking write operation with a memory barrier to ensure order of stores.
@NotNull MappedBytesStore	writeShort(long offset, short i16) Writes a short integer at the specified non-negative offset.
@NotNull MappedBytesStore	writeVolatileByte(long offset, byte i8) Writes a volatile byte at the specified non-negative offset.
@NotNull MappedBytesStore	writeVolatileInt(long offset, int i32) Writes a volatile integer at the specified non-negative offset.
@NotNull MappedBytesStore	writeVolatileLong(long offset, long i64) Writes a volatile long integer at the specified non-negative offset.
@NotNull MappedBytesStore	writeVolatileShort(long offset, short i16) Writes a volatile short at the specified non-negative offset.
@NotNull MappedBytesStore	zeroOut(long start, long end) Fills the BytesStore with zeros.

Methods inherited from class net.openhft.chronicle.bytes.internal.NativeBytesStore

addressForRead, addressForWrite, addressForWritePosition, appendAndReturnLength, backgroundPerformRelease, byteCheckSum, byteCheckSum, canReadDirect, capacity, copy, copyTo, copyToDirect, elasticByteBuffer, elasticByteBuffer, equals, fastHash, follow, from, from, hashCode, isDirectMemory, isEqual, lazyNativeBytesStoreWithFixedCapacity, move, nativeRead, nativeStore, nativeStoreWithFixedCapacity, peekUnsignedByte, read, read8bit, readDouble, readFloat, readIncompleteLong, readInt, readLong, readShort, readUnsignedByte, readVolatileByte, readVolatileInt, readVolatileLong, readVolatileShort, realCapacity, reverseBytesFrom, setAddress, sharedMemory, testAndSetInt, toString, toTemporaryDirectByteBuffer, underlyingObject, uninitialized, wrap, write8bit, write8bit

Methods inherited from class net.openhft.chronicle.bytes.internal.AbstractBytesStore

canReleaseInBackground, readRemaining, writeRemaining

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

addReferenceChangeListener, assertReferencesReleased, createdHere, disableReferenceTracing, enableReferenceTracing, refCount, referenceCountedUnmonitored, referenceId, release, releaseLast, removeReferenceChangeListener, reserve, reserveTransfer, singleThreadedCheckDisabled, singleThreadedCheckReset, threadSafetyCheck, throwExceptionIfNotReleased, throwExceptionIfReleased, tryReserve, unmonitor, unmonitor, warnAndReleaseIfNotReleased

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

addAndGetDouble, addAndGetDoubleNotAtomic, addAndGetFloat, addAndGetFloatNotAtomic, addAndGetInt, addAndGetIntNotAtomic, addAndGetLong, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, bytesStore, charAt, cipher, cipher, compareAndSwapDouble, compareAndSwapFloat, contentEquals, copyTo, empty, endsWith, equalBytes, forFields, from, from, hash, isClear, isEmpty, length, nativePointer, nativeStoreFrom, readWrite, startsWith, startsWith, subSequence, to8bitString, toDebugString, toDebugString, toUtf8String, wrap, wrap, writeMaxInt, writeMaxLong

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

canReadDirect, compareUtf8, copyTo, copyTo, findByte, parseLong, peekVolatileInt, printable, readBoolean, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileDouble, readVolatileFloat, subBytes, toByteArray

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

append, append, write, write, writeBoolean, writeByte, writeInt24, writeOrderedDouble, writeOrderedFloat, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUtf8Limited, writeVolatileDouble, writeVolatileFloat

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

addressForRead, byteOrder, lengthWritten, readLimit, realReadRemaining, realWriteRemaining, writeLimit, writePosition

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

addReferenceChangeListener, refCount, release, releaseLast, releaseLast, removeReferenceChangeListener, reserve, reserveTransfer, tryReserve

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

referenceId, referenceName, temporary

Methods inherited from interface java.lang.CharSequence

chars, codePoints

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

onReleased

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

unmonitor

Field Detail

writeCheck

protected final Runnable writeCheck

run before each write, throws if read only

Constructor Detail

MappedBytesStore

protected MappedBytesStore(net.openhft.chronicle.core.io.ReferenceOwner owner,
                           MappedFile mappedFile,
                           long start,
                           long address,
                           long capacity,
                           long safeCapacity,
                           int pageSize)
                    throws net.openhft.chronicle.core.io.ClosedIllegalStateException

Constructs a MappedBytesStore for a mapped region.

Parameters:

owner - reference owner

mappedFile - parent mapped file

start - logical start offset

address - native address of the mapping

capacity - mapped capacity

safeCapacity - portion guaranteed not to cross a chunk

pageSize - page size for alignment

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException

Method Detail

create

public static MappedBytesStore create(net.openhft.chronicle.core.io.ReferenceOwner owner,
                                      MappedFile mappedFile,
                                      long start,
                                      long address,
                                      long capacity,
                                      long safeCapacity,
                                      int pageSize)
                               throws net.openhft.chronicle.core.io.ClosedIllegalStateException

Factory method mirroring the protected constructor.

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException

underlyingCapacity

public long underlyingCapacity()

Returns:

capacity of the underlying file, which may differ from NativeBytesStore.capacity() if alignment is applied

bytesForRead

@NotNull
public @NotNull Bytes<Void> bytesForRead()
                                           throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                  net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: BytesStore

Returns a Bytes that wraps this ByteStore from the start to the realCapacity.

The returned Bytes is not elastic and can be both read and written using cursors.

Returns:

a Bytes that wraps this ByteStore

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.

bytesForWrite

@NotNull
public @NotNull VanillaBytes<Void> bytesForWrite()
                                                   throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                          net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: BytesStore

Returns a Bytes that wraps this ByteStore from the start to the realCapacity.

The returned Bytes is not elastic and can be both read and written using cursors.

Specified by:

bytesForWrite in interface BytesStore<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>,Void>

Specified by:

bytesForWrite in interface RandomCommon

Overrides:

bytesForWrite in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Returns:

a Bytes that wraps this BytesStore

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.

inside

public boolean inside(long offset)

Returns true if the given offset lies within this mapping's safe range.

Parameters:

offset - byte index to check

Returns:

true if the offset is within RandomCommon.start() and BytesStore.safeLimit()

inside

public boolean inside(long offset,
                      long bufferSize)

Same as inside(long) but also checks the end of the supplied range.

safeLimit

public long safeLimit()

Specified by:

safeLimit in interface BytesStore<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>,Void>

Overrides:

safeLimit in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Returns:

how many bytes can be safely read, i.e. what is the real capacity of the underlying data.

readByte

public byte readByte(long offset)

Description copied from interface: RandomDataInput

Reads a byte value from a specific offset.

Specified by:

readByte in interface RandomDataInput

Overrides:

readByte in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - the location from where the byte value is read.

Returns:

the read byte value.

writeOrderedInt

@NotNull
public @NotNull MappedBytesStore writeOrderedInt(long offset,
                                                          int i)
                                                   throws IllegalStateException

Description copied from interface: RandomDataOutput

Performs a non-blocking write operation with a memory barrier to ensure order of stores. Writes an integer at the specified non-negative offset.

Specified by:

writeOrderedInt in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

writeOrderedInt in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - The non-negative position within the data stream to write the integer to.

i - The integer value to write.

Returns:

Reference to the current instance, allowing for method chaining.

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

translate

public long translate(long offset)

Converts a logical offset in the file into an offset relative to this mapped region.

Overrides:

translate in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - logical offset within the store

Returns:

same value as offset

start

public long start()

Specified by:

start in interface RandomCommon

Overrides:

start in class net.openhft.chronicle.bytes.internal.AbstractBytesStore<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>,Void>

Returns:

The smallest position allowed in this buffer.

readPosition

public long readPosition()

Description copied from interface: RandomCommon

/**

Specified by:

readPosition in interface RandomCommon

Overrides:

readPosition in class net.openhft.chronicle.bytes.internal.AbstractBytesStore<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>,Void>

Returns:

the current read position. Typically start() <= readPosition() <= writePosition() and readPosition() <= readLimit().

lock

public FileLock lock(long position,
                     long size,
                     boolean shared)
              throws IOException

Acquires a lock on a region of the underlying file. This method blocks until the lock has been acquired.

Parameters:

position - The starting byte position of the region to lock.

size - The number of bytes to lock, starting from the position.

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

Returns:

A FileLock representing the lock on the specified region.

Throws:

IOException - If an I/O error occurs while locking.

See Also:

for details on how the lock is acquired.

tryLock

public FileLock tryLock(long position,
                        long size,
                        boolean shared)
                 throws IOException

Attempts to acquire a lock on a region of the underlying file. This method does not block and returns immediately, either with a lock or with null if the lock could not be acquired.

Parameters:

position - The starting byte position of the region to lock.

size - The number of bytes to lock, starting from the position.

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

Returns:

A FileLock representing the lock on the specified region or null if the lock could not be acquired.

Throws:

IOException - If an I/O error occurs while trying to lock.

See Also:

for details on how the lock is attempted.

zeroOut

@NotNull
public @NotNull MappedBytesStore zeroOut(long start,
                                                  long end)

Description copied from interface: BytesStore

Fills the BytesStore with zeros.

Specified by:

zeroOut in interface BytesStore<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>,Void>

Specified by:

zeroOut in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

zeroOut in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

start - first byte inclusive

end - last byte exclusive

Returns:

this

compareAndSwapInt

public boolean compareAndSwapInt(long offset,
                                 int expected,
                                 int value)
                          throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                 net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Performs a 32-bit compare-and-swap (CAS) operation at a given offset.

Specified by:

compareAndSwapInt in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

compareAndSwapInt in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - the offset at which to perform the CAS operation.

expected - the expected current value.

value - the new value to set if the current value matches the expected value.

Returns:

true if the CAS operation was 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

compareAndSwapLong

public boolean compareAndSwapLong(long offset,
                                  long expected,
                                  long value)
                           throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                  net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Performs a 64-bit compare-and-swap (CAS) operation at a given offset.

Specified by:

compareAndSwapLong in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

compareAndSwapLong in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - the offset at which to perform the CAS operation.

expected - the expected current value.

value - the new value to set if the current value matches the expected value.

Returns:

true if the CAS operation was 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

writeByte

@NotNull
public @NotNull MappedBytesStore writeByte(long offset,
                                                    byte i8)
                                             throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                    net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Writes a byte at the specified non-negative offset.

Specified by:

writeByte in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

writeByte in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - The non-negative position within the data stream to write the byte to.

i8 - The byte value to write.

Returns:

Reference to the current instance, allowing for method chaining.

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

writeShort

@NotNull
public @NotNull MappedBytesStore writeShort(long offset,
                                                     short i16)
                                              throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Writes a short integer at the specified non-negative offset.

Specified by:

writeShort in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

writeShort in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - The non-negative position within the data stream to write the short integer to.

i16 - The short integer value to write.

Returns:

Reference to the current instance, allowing for method chaining.

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

writeInt

@NotNull
public @NotNull MappedBytesStore writeInt(long offset,
                                                   int i32)
                                            throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                   net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Writes an integer value at the specified non-negative offset.

Specified by:

writeInt in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

writeInt in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - The non-negative position within the data stream to write the integer to.

i32 - The integer value to write.

Returns:

Reference to the current instance, allowing for method chaining.

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

writeLong

@NotNull
public @NotNull MappedBytesStore writeLong(long offset,
                                                    long i64)
                                             throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                    net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Writes a long integer value at the specified non-negative offset.

Specified by:

writeLong in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

writeLong in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - The non-negative position within the data stream to write the long integer to.

i64 - The long integer value to write.

Returns:

Reference to the current instance, allowing for method chaining.

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

writeOrderedLong

@NotNull
public @NotNull MappedBytesStore writeOrderedLong(long offset,
                                                           long i)
                                                    throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                           net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Performs a non-blocking write operation with a memory barrier to ensure order of stores. Writes a long integer at the specified non-negative offset.

Specified by:

writeOrderedLong in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

writeOrderedLong in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - The non-negative position within the data stream to write the long integer to.

i - The long integer value to write.

Returns:

Reference to the current instance, allowing for method chaining.

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

writeFloat

@NotNull
public @NotNull MappedBytesStore writeFloat(long offset,
                                                     float f)
                                              throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Writes a single-precision floating-point value at the specified non-negative offset.

Specified by:

writeFloat in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

writeFloat in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - The non-negative position within the data stream to write the float to.

f - The float value to write.

Returns:

Reference to the current instance, allowing for method chaining.

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

writeDouble

@NotNull
public @NotNull MappedBytesStore writeDouble(long offset,
                                                      double d)
                                               throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                      net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Writes a double-precision floating-point value at the specified non-negative offset.

Specified by:

writeDouble in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

writeDouble in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - The non-negative position within the data stream to write the double to.

d - The double value to write.

Returns:

Reference to the current instance, allowing for method chaining.

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

writeVolatileByte

@NotNull
public @NotNull MappedBytesStore writeVolatileByte(long offset,
                                                            byte i8)
                                                     throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                            net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Writes a volatile byte at the specified non-negative offset. The write is volatile, ensuring it is not cached and instantly visible to all threads.

Specified by:

writeVolatileByte in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

writeVolatileByte in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - The non-negative position within the data stream to write the byte to.

i8 - The byte value to write.

Returns:

Reference to the current instance, allowing for method chaining.

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

writeVolatileShort

@NotNull
public @NotNull MappedBytesStore writeVolatileShort(long offset,
                                                             short i16)
                                                      throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                             net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Writes a volatile short at the specified non-negative offset. The write is volatile, ensuring it is not cached and instantly visible to all threads.

Specified by:

writeVolatileShort in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

writeVolatileShort in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - The non-negative position within the data stream to write the short to.

i16 - The short value to write.

Returns:

Reference to the current instance, allowing for method chaining.

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

writeVolatileInt

@NotNull
public @NotNull MappedBytesStore writeVolatileInt(long offset,
                                                           int i32)
                                                    throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                           net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Writes a volatile integer at the specified non-negative offset. The write is volatile, ensuring it is not cached and instantly visible to all threads.

Specified by:

writeVolatileInt in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

writeVolatileInt in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - The non-negative position within the data stream to write the integer to.

i32 - The integer value to write.

Returns:

Reference to the current instance, allowing for method chaining.

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

writeVolatileLong

@NotNull
public @NotNull MappedBytesStore writeVolatileLong(long offset,
                                                            long i64)
                                                     throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                            net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Writes a volatile long integer at the specified non-negative offset. The write is volatile, ensuring it is not cached and instantly visible to all threads.

Specified by:

writeVolatileLong in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

writeVolatileLong in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offset - The non-negative position within the data stream to write the long integer to.

i64 - The long integer value to write.

Returns:

Reference to the current instance, allowing for method chaining.

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

write

@NotNull
public @NotNull MappedBytesStore write(long offsetInRDO,
                                                byte[] byteArray,
                                                int offset,
                                                int length)
                                         throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Copies the provided byteArray to this Bytes object starting at writeOffset taking content starting at readOffset but copying at most length bytes.

Does not update cursors e.g. RandomCommon.writePosition()

Specified by:

write in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

write in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offsetInRDO - the non-negative offset within the data output where the segment should be written.

byteArray - the byte array containing the segment to be written.

offset - the non-negative offset within the byte array where the segment begins.

length - the non-negative length of the segment.

Returns:

a reference to this instance.

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

write

public void write(long offsetInRDO,
                  @NotNull
                  @NotNull ByteBuffer bytes,
                  int offset,
                  int length)
           throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                  net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Copies a segment from the provided ByteBuffer into this data output.

Does not update cursors e.g. RandomCommon.writePosition()

Specified by:

write in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

write in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

offsetInRDO - the non-negative offset within the data output where the segment should be written.

bytes - the ByteBuffer containing the segment to be written.

offset - the non-negative offset within the ByteBuffer where the segment begins.

length - the non-negative length of the segment.

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

write

@NotNull
public @NotNull MappedBytesStore write(long writeOffset,
                                                @NotNull
                                                @NotNull RandomDataInput bytes,
                                                long readOffset,
                                                long length)
                                         throws BufferOverflowException,
                                                BufferUnderflowException,
                                                net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Copies a segment from the provided RandomDataInput into this data output. This operation does not update the RandomCommon.writePosition() of this output nor the RandomCommon.readPosition() of the input.

Specified by:

write in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

write in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

writeOffset - the non-negative offset within this data output where the segment should be written.

bytes - the RandomDataInput source containing the segment to be written.

readOffset - the non-negative offset within the source where the segment begins.

length - the non-negative length of the segment.

Returns:

a reference to this instance.

Throws:

BufferOverflowException - If the capacity of this data output was exceeded.

BufferUnderflowException - If the source does not have enough data to fill the length.

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

write0

public void write0(long offsetInRDO,
                   @NotNull
                   @NotNull RandomDataInput bytes,
                   long offset,
                   long length)
            throws net.openhft.chronicle.core.io.ClosedIllegalStateException

Overrides:

write0 in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException

nativeWrite

public void nativeWrite(long address,
                        long position,
                        long size)
                 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                        net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataOutput

Expert-level method that copies data directly from native memory into this BytesStore.

Specified by:

nativeWrite in interface RandomDataOutput<net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>>

Overrides:

nativeWrite in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Parameters:

address - the address in the native memory from where data should be copied.

position - the position in the BytesStore where data should be written.

size - the size of the data, in bytes, to be copied from the native memory.

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

appendUtf8

public long appendUtf8(long pos,
                       char[] chars,
                       int offset,
                       int length)
                throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Overrides:

appendUtf8 in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException

net.openhft.chronicle.core.io.ThreadingIllegalStateException

performRelease

protected void performRelease()

Syncs the mapped region to disk prior to release if required.

Overrides:

performRelease in class net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

syncMode

public SyncMode syncMode()

Returns:

the sync mode for this ByteStore

syncMode

public void syncMode(SyncMode syncMode)

Set the sync mode for this ByteStore

Parameters:

syncMode - to use

syncUpTo

public void syncUpTo(long position)

Synchronise from the last complete page up to this position.

Parameters:

position - to sync with the syncMode()

syncUpTo

public void syncUpTo(long position,
                     SyncMode syncMode)

Synchronise from the last complete page up to this position.

Parameters:

position - to sync with the syncMode()

syncMode - to use