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:

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

Direct Known Subclasses:

ReadOnlyMappedBytesStore

public class MappedBytesStore
extends NativeBytesStore<Void>

BytesStore to wrap memory mapped data.

Field Summary

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

address, maximumLimit, memory, releasedHere

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 long	addressForRead(long offset, int buffer)
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.
boolean	inside(long offset, int buffer)
byte	readByte(long offset) Read byte at an offset
default long	readLimit()
long	readPosition() The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()
long	safeLimit()
long	start()
protected long	translate(long offset)
default long	writeLimit()
NativeBytesStore<Void>	writeOrderedInt(long offset, int i) Perform a non stalling write with a store barrier.
default long	writePosition() The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
default long	writeRemaining()

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

addAndGetInt, addAndGetLong, addressForRead, addressForWrite, appendUTF, appendUtf8, byteCheckSum, byteCheckSum, capacity, checkReleased, compareAndSwapInt, compareAndSwapLong, copy, copyTo, copyToDirect, elasticByteBuffer, elasticByteBuffer, equals, fastHash, from, from, init, isDirectMemory, lazyNativeBytesStoreWithFixedCapacity, move, nativeRead, nativeStore, nativeStoreWithFixedCapacity, nativeWrite, peekUnsignedByte, read, readDouble, readFloat, readIncompleteLong, readInt, readLong, readShort, readUnsignedByte, readVolatileByte, readVolatileInt, readVolatileLong, readVolatileShort, realCapacity, refCount, release, reserve, setAddress, sharedMemory, testAndSetInt, toString, toTemporaryDirectByteBuffer, tryReserve, underlyingObject, uninit, uninitialized, wrap, write, write, write, write0, writeByte, writeDouble, writeFloat, writeInt, writeLong, writeOrderedLong, writeShort, writeVolatileByte, writeVolatileInt, writeVolatileLong, writeVolatileShort, zeroOut

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

hashCode, readRemaining

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, cipher, cipher, contentEquals, copyTo, empty, endsWith, equalBytes, from, isClear, isEmpty, isPresent, isPresent, length, longCheckSum, nativePointer, readWrite, startsWith, startsWith, subSequence, to8bitString, toDebugString, toDebugString, wrap, wrap, writeMaxLong

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

addAndGetDouble, addAndGetFloat, compareUtf8, copyTo, copyTo, createCharToString, 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.core.ReferenceCounted

release, releaseAll

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.

inside

public boolean inside(long offset,
                      int buffer)

safeLimit

public long safeLimit()

Specified by:

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

Overrides:

safeLimit in class 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

Read byte at an offset

Specified by:

readByte in interface RandomDataInput

Overrides:

readByte in class NativeBytesStore<Void>

Parameters:

offset - to read

Returns:

the byte

writeOrderedInt

@NotNull
public NativeBytesStore<Void> writeOrderedInt(long offset,
                                                       int i)

Description copied from interface: RandomDataOutput

Perform a non stalling write with a store barrier.

Specified by:

writeOrderedInt in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

writeOrderedInt in class NativeBytesStore<Void>

Parameters:

offset - to write to

i - value to write

Returns:

this

translate

protected long translate(long offset)

Overrides:

translate in class NativeBytesStore<Void>

start

public long start()

Overrides:

start in class AbstractBytesStore<NativeBytesStore<Void>,Void>

Returns:

The smallest position allowed in this buffer.

readPosition

public long readPosition()

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

Overrides:

readPosition in class AbstractBytesStore<NativeBytesStore<Void>,Void>

Returns:

position to read from.

writePosition

public long writePosition()

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

Returns:

position to write to.

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

addressForRead

public long addressForRead(long offset,
                           int buffer)
                    throws UnsupportedOperationException,
                           BufferUnderflowException

Throws:

UnsupportedOperationException

BufferUnderflowException

byteOrder

public ByteOrder byteOrder()

compareAndSwapFloat

public boolean compareAndSwapFloat(long offset,
                                   float expected,
                                   float value)
                            throws BufferOverflowException

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

compareAndSwapDouble

public boolean compareAndSwapDouble(long offset,
                                    double expected,
                                    double value)
                             throws BufferOverflowException

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