net.openhft.chronicle.bytes

Class MappedBytesStore

java.lang.Object

net.openhft.chronicle.bytes.AbstractBytesStore<NativeBytesStore<Underlying>,Underlying>

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

net.openhft.chronicle.bytes.MappedBytesStore

All Implemented Interfaces:

Closeable, AutoCloseable, CharSequence, BytesStore<NativeBytesStore<Void>,Void>, RandomDataInput, RandomDataOutput<NativeBytesStore<Void>>, net.openhft.chronicle.core.ReferenceCounted

public class MappedBytesStore
extends NativeBytesStore<Void>

BytesStore to wrap memory mapped data.

Field Summary

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

address, memory

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

charToString

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MappedBytesStore(net.openhft.chronicle.core.ReferenceCounted owner, long start, long address, long capacity, long safeCapacity)

Method Summary

Modifier and Type	Method and Description
default ByteOrder	byteOrder()
VanillaBytes<Void>	bytesForWrite()
default boolean	compareAndSwapDouble(long offset, double expected, double value) Perform a 64-bit double CAS at a given offset.
default boolean	compareAndSwapFloat(long offset, float expected, float value) Perform a 32-bit float CAS at a given offset.
boolean	inside(long offset) Use this test to determine if an offset is considered safe.
default long	readLimit()
default long	readPosition() The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()
default long	readRemaining()
long	safeLimit()
long	start()
default long	writeLimit()
default long	writePosition() The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
default long	writeRemaining()

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

address, appendUTF, appendUtf8, byteCheckSum, byteCheckSum, capacity, checkReleased, compareAndSwapInt, compareAndSwapLong, copy, copyTo, copyTo, elasticByteBuffer, elasticByteBuffer, equals, init, lazyNativeBytesStoreWithFixedCapacity, move, nativeRead, nativeStore, nativeStoreWithFixedCapacity, nativeWrite, read, readByte, readDouble, readFloat, readIncompleteLong, readInt, readLong, readShort, readVolatileByte, readVolatileInt, readVolatileLong, readVolatileShort, realCapacity, refCount, release, reserve, setAddress, sharedMemory, toString, toTemporaryDirectByteBuffer, underlyingObject, uninit, uninitialized, wrap, write, write, write, write0, writeByte, writeDouble, writeFloat, writeInt, writeLong, writeOrderedInt, writeOrderedLong, writeShort, writeVolatileByte, writeVolatileInt, writeVolatileLong, writeVolatileShort, zeroOut

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

hashCode

Methods inherited from class java.lang.Object

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

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

addAndGetByteNotAtomic, addAndGetDoubleNotAtomic, addAndGetFloatNotAtomic, addAndGetIntNotAtomic, addAndGetLongNotAtomic, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, addAndGetUnsignedIntNotAtomic, addAndGetUnsignedShortNotAtomic, bytesForRead, bytesStore, charAt, contentEquals, copyTo, empty, endsWith, equalBytes, from, isClear, isNative, isPresent, isPresent, length, longCheckSum, nativePointer, startsWith, startsWith, subSequence, to8bitString, toDebugString, toDebugString, wrap, wrap, wrap, writeMaxLong

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

addAndGetDouble, addAndGetFloat, addAndGetInt, addAndGetLong, compareUtf8, copyTo, copyTo, createCharToString, fastHash, findByte, parseLong, printable, readBoolean, readUnsignedByte, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileDouble, readVolatileFloat, subBytes, toByteArray

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

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

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

close, release, releaseAll, tryReserve

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

closeQuietly, isClosed, notifyClosing

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Constructor Detail

MappedBytesStore

protected MappedBytesStore(net.openhft.chronicle.core.ReferenceCounted owner,
                           long start,
                           long address,
                           long capacity,
                           long safeCapacity)
                    throws IllegalStateException

Throws:

IllegalStateException

Method Detail

bytesForWrite

@NotNull
public VanillaBytes<Void> bytesForWrite()
                                          throws IllegalStateException

Specified by:

bytesForWrite in interface BytesStore<NativeBytesStore<Void>,Void>

Overrides:

bytesForWrite in class NativeBytesStore<Void>

Returns:

a Bytes for writing to this BytesStore

Throws:

IllegalStateException

inside

public boolean inside(long offset)

Description copied from interface: BytesStore

Use this test to determine if an offset is considered safe.

safeLimit

public long safeLimit()

Returns:

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

start

public long start()

Overrides:

start in class NativeBytesStore<Void>

Returns:

The smallest position allowed in this buffer.

readPosition

public long readPosition()

The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()

Returns:

position to read from.

writePosition

public long writePosition()

The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()

Returns:

position to write to.

readRemaining

public long readRemaining()

Returns:

How many more bytes can we read.

writeRemaining

public long writeRemaining()

Returns:

How many more bytes can we written.

readLimit

public long readLimit()

Returns:

the highest offset or position allowed for this buffer.

writeLimit

public long writeLimit()

byteOrder

public ByteOrder byteOrder()

compareAndSwapFloat

public boolean compareAndSwapFloat(long offset,
                                   float expected,
                                   float value)
                            throws BufferOverflowException,
                                   IllegalArgumentException,
                                   net.openhft.chronicle.core.io.IORuntimeException

Perform a 32-bit float CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

BufferOverflowException

IllegalArgumentException

net.openhft.chronicle.core.io.IORuntimeException

compareAndSwapDouble

public boolean compareAndSwapDouble(long offset,
                                    double expected,
                                    double value)
                             throws BufferOverflowException,
                                    IllegalArgumentException,
                                    net.openhft.chronicle.core.io.IORuntimeException

Perform a 64-bit double CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

BufferOverflowException

IllegalArgumentException

net.openhft.chronicle.core.io.IORuntimeException