net.openhft.chronicle.bytes

Class AbstractBytesStore<B extends BytesStore<B,Underlying>,Underlying>

java.lang.Object

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

All Implemented Interfaces:

Closeable, AutoCloseable, CharSequence, BytesStore<B,Underlying>, RandomDataInput, RandomDataOutput<B>, net.openhft.chronicle.core.ReferenceCounted

Direct Known Subclasses:

HeapBytesStore, NativeBytesStore

public abstract class AbstractBytesStore<B extends BytesStore<B,Underlying>,Underlying>
extends Object
implements BytesStore<B,Underlying>

Created by peter on 07/05/16.

Field Summary

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

charToString

Constructor Summary

Constructors

Constructor and Description
AbstractBytesStore()

Method Summary

Modifier and Type	Method and Description
long	address(long offset) Obtain the underlying address.
default ByteOrder	byteOrder()
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	compareAndSwapInt(long offset, int expected, int value) Perform a 32-bit CAS at a given offset.
boolean	compareAndSwapLong(long offset, long expected, long value) Perform a 64-bit CAS at a given offset.
int	hashCode()
default long	readLimit()
default long	readPosition() The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()
default long	readRemaining()
boolean	sharedMemory()
default long	start()
default long	writeLimit()
default long	writePosition() The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
default long	writeRemaining()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

addAndGetByteNotAtomic, addAndGetDoubleNotAtomic, addAndGetFloatNotAtomic, addAndGetIntNotAtomic, addAndGetLongNotAtomic, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, addAndGetUnsignedIntNotAtomic, addAndGetUnsignedShortNotAtomic, byteCheckSum, bytesForRead, bytesForWrite, bytesStore, capacity, charAt, contentEquals, copy, copyTo, copyTo, empty, endsWith, equalBytes, from, inside, isClear, isNative, isPresent, isPresent, length, longCheckSum, move, nativePointer, realCapacity, safeLimit, startsWith, startsWith, subSequence, to8bitString, toDebugString, toDebugString, underlyingObject, wrap, wrap, wrap, wrap, writeMaxLong, zeroOut

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

addAndGetDouble, addAndGetFloat, addAndGetInt, addAndGetLong, compareUtf8, copyTo, copyTo, createCharToString, fastHash, findByte, nativeRead, parseLong, printable, read, readBoolean, readByte, readDouble, readFloat, readIncompleteLong, readInt, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileByte, readVolatileDouble, readVolatileFloat, readVolatileInt, readVolatileLong, readVolatileShort, subBytes, toByteArray, toTemporaryDirectByteBuffer

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

append, nativeWrite, write, write, write, write, write, writeBoolean, writeByte, writeByte, writeDouble, writeFloat, writeInt, writeInt24, writeLong, writeOrderedDouble, writeOrderedFloat, writeOrderedInt, writeOrderedLong, writeShort, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUtf8Limited, writeVolatileByte, writeVolatileDouble, writeVolatileFloat, writeVolatileInt, writeVolatileLong, writeVolatileShort

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

close, refCount, release, release, releaseAll, reserve, tryReserve

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

closeQuietly, isClosed, notifyClosing

Methods inherited from interface java.lang.CharSequence

chars, codePoints, toString

Constructor Detail

AbstractBytesStore

public AbstractBytesStore()

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

start

public long start()

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

address

public long address(long offset)
             throws UnsupportedOperationException,
                    IllegalArgumentException

Obtain the underlying address. This is for expert users only.

Parameters:

offset - within this buffer. address(start()) is the actual address of the first byte.

Returns:

the underlying address of the buffer

Throws:

UnsupportedOperationException - if the underlying buffer is on the heap

IllegalArgumentException - if the offset is before the start() or the after the capacity()

byteOrder

public ByteOrder byteOrder()

compareAndSwapInt

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

Perform a 32-bit 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

compareAndSwapLong

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

Perform a 64-bit 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

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

sharedMemory

public boolean sharedMemory()

Returns:

true if these Bytes use shared memory.