net.openhft.chronicle.bytes

Class NativeBytesStore<Underlying>

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

MappedBytesStore, PointerBytesStore

public class NativeBytesStore<Underlying>
extends Object
implements BytesStore<NativeBytesStore<Underlying>,Underlying>

Field Summary

Fields

Modifier and Type	Field and Description
protected long	address
protected net.openhft.chronicle.core.Memory	memory

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

charToString

Constructor Summary

Constructors

Constructor and Description
NativeBytesStore(long address, long maximumLimit, Runnable deallocator, boolean elastic)

Method Summary

Modifier and Type	Method and Description
long	address(long offset) Obtain the underlying address.
default ByteOrder	byteOrder()
VanillaBytes<Underlying>	bytesForWrite()
long	capacity()
void	checkReleased()
boolean	compareAndSwapInt(long offset, int expected, int value)
boolean	compareAndSwapLong(long offset, long expected, long value)
BytesStore<NativeBytesStore<Underlying>,Underlying>	copy()
static NativeBytesStore<ByteBuffer>	elasticByteBuffer()
static NativeBytesStore<ByteBuffer>	elasticByteBuffer(int size)
boolean	equals(Object obj)
static NativeBytesStore<Void>	lazyNativeBytesStoreWithFixedCapacity(long capacity)
void	nativeRead(long position, long address, long size) expert level method for copying data to native memory.
static NativeBytesStore<Void>	nativeStore(long capacity) this is an elastic native store
static NativeBytesStore<Void>	nativeStoreWithFixedCapacity(long capacity)
void	nativeWrite(long address, long position, long size) expert level method to copy data from native memory into the BytesStore
byte	readByte(long offset)
double	readDouble(long offset)
float	readFloat(long offset)
long	readIncompleteLong(long offset)
int	readInt(long offset)
default long	readLimit()
long	readLong(long offset)
default long	readPosition()
default long	readRemaining()
short	readShort(long offset)
int	readVolatileInt(long offset)
long	readVolatileLong(long offset)
long	realCapacity()
long	refCount()
void	release()
void	reserve()
void	setAddress(long address)
default long	start()
String	toString()
Underlying	underlyingObject()
static NativeBytesStore<ByteBuffer>	wrap(ByteBuffer bb)
NativeBytesStore<Underlying>	write(long offsetInRDO, byte[] bytes, int offset, int length)
void	write(long offsetInRDO, ByteBuffer bytes, int offset, int length)
NativeBytesStore<Underlying>	write(long offsetInRDO, RandomDataInput bytes, long offset, long length)
NativeBytesStore<Underlying>	writeByte(long offset, byte i8)
NativeBytesStore<Underlying>	writeDouble(long offset, double d)
NativeBytesStore<Underlying>	writeFloat(long offset, float f)
NativeBytesStore<Underlying>	writeInt(long offset, int i32)
default long	writeLimit()
NativeBytesStore<Underlying>	writeLong(long offset, long i64)
NativeBytesStore<Underlying>	writeOrderedInt(long offset, int i)
NativeBytesStore<Underlying>	writeOrderedLong(long offset, long i)
default long	writePosition()
default long	writeRemaining()
NativeBytesStore<Underlying>	writeShort(long offset, short i16)
NativeBytesStore<Underlying>	zeroOut(long start, long end)

Methods inherited from class java.lang.Object

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

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

addAndGetInt, addAndGetLong, byteCheckSum, bytesForRead, bytesStore, charAt, copyTo, equalBytes, getAndAddInt, inside, isClear, length, nativePointer, safeLimit, subSequence, toDebugString, wrap

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

bytesEqual, copyTo, createCharToString, parseLong, printable, readBoolean, readUnsignedByte, readUnsignedInt, readUnsignedShort

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

append, write, write, writeBoolean, writeByte, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort

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

close, release, releaseAll, tryReserve

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

closeQuietly

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Field Detail

memory

@Nullable
protected net.openhft.chronicle.core.Memory memory

address

protected long address

Constructor Detail

NativeBytesStore

public NativeBytesStore(long address,
                        long maximumLimit,
                        @Nullable
                        Runnable deallocator,
                        boolean elastic)

Method Detail

wrap

@NotNull
public static NativeBytesStore<ByteBuffer> wrap(@NotNull
                                                         ByteBuffer bb)

Specified by:

wrap in interface BytesStore<NativeBytesStore<Underlying>,Underlying>

nativeStore

@NotNull
public static NativeBytesStore<Void> nativeStore(long capacity)

this is an elastic native store

Parameters:

capacity - of the buffer.

nativeStoreWithFixedCapacity

@NotNull
public static NativeBytesStore<Void> nativeStoreWithFixedCapacity(long capacity)

lazyNativeBytesStoreWithFixedCapacity

@NotNull
public static NativeBytesStore<Void> lazyNativeBytesStoreWithFixedCapacity(long capacity)

elasticByteBuffer

@NotNull
public static NativeBytesStore<ByteBuffer> elasticByteBuffer()

elasticByteBuffer

@NotNull
public static NativeBytesStore<ByteBuffer> elasticByteBuffer(int size)

copy

@NotNull
public BytesStore<NativeBytesStore<Underlying>,Underlying> copy()

Specified by:

copy in interface BytesStore<NativeBytesStore<Underlying>,Underlying>

Returns:

a copy of this BytesStore.

bytesForWrite

public VanillaBytes<Underlying> bytesForWrite()

Specified by:

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

Returns:

the streaming bytes for writing.

realCapacity

public long realCapacity()

Specified by:

realCapacity in interface BytesStore<NativeBytesStore<Underlying>,Underlying>

Specified by:

realCapacity in interface RandomDataInput

Returns:

the actual capacity available before resizing.

capacity

public long capacity()

Specified by:

capacity in interface BytesStore<NativeBytesStore<Underlying>,Underlying>

Returns:

The maximum limit you can set.

underlyingObject

@Nullable
public Underlying underlyingObject()

Specified by:

underlyingObject in interface BytesStore<NativeBytesStore<Underlying>,Underlying>

zeroOut

@NotNull
public NativeBytesStore<Underlying> zeroOut(long start,
                                                     long end)

Specified by:

zeroOut in interface BytesStore<NativeBytesStore<Underlying>,Underlying>

Specified by:

zeroOut in interface RandomDataOutput<NativeBytesStore<Underlying>>

compareAndSwapInt

public boolean compareAndSwapInt(long offset,
                                 int expected,
                                 int value)

Specified by:

compareAndSwapInt in interface BytesStore<NativeBytesStore<Underlying>,Underlying>

compareAndSwapLong

public boolean compareAndSwapLong(long offset,
                                  long expected,
                                  long value)

Specified by:

compareAndSwapLong in interface BytesStore<NativeBytesStore<Underlying>,Underlying>

reserve

public void reserve()

Specified by:

reserve in interface net.openhft.chronicle.core.ReferenceCounted

release

public void release()

Specified by:

release in interface net.openhft.chronicle.core.ReferenceCounted

refCount

public long refCount()

Specified by:

refCount in interface net.openhft.chronicle.core.ReferenceCounted

readByte

public byte readByte(long offset)

Specified by:

readByte in interface RandomDataInput

checkReleased

public void checkReleased()

readShort

public short readShort(long offset)

Specified by:

readShort in interface RandomDataInput

readInt

public int readInt(long offset)

Specified by:

readInt in interface RandomDataInput

readLong

public long readLong(long offset)

Specified by:

readLong in interface RandomDataInput

readFloat

public float readFloat(long offset)

Specified by:

readFloat in interface RandomDataInput

readDouble

public double readDouble(long offset)

Specified by:

readDouble in interface RandomDataInput

readVolatileInt

public int readVolatileInt(long offset)

Specified by:

readVolatileInt in interface RandomDataInput

readVolatileLong

public long readVolatileLong(long offset)

Specified by:

readVolatileLong in interface RandomDataInput

writeByte

@NotNull
public NativeBytesStore<Underlying> writeByte(long offset,
                                                       byte i8)

Specified by:

writeByte in interface RandomDataOutput<NativeBytesStore<Underlying>>

writeShort

@NotNull
public NativeBytesStore<Underlying> writeShort(long offset,
                                                        short i16)

Specified by:

writeShort in interface RandomDataOutput<NativeBytesStore<Underlying>>

writeInt

@NotNull
public NativeBytesStore<Underlying> writeInt(long offset,
                                                      int i32)

Specified by:

writeInt in interface RandomDataOutput<NativeBytesStore<Underlying>>

writeOrderedInt

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

Specified by:

writeOrderedInt in interface RandomDataOutput<NativeBytesStore<Underlying>>

writeLong

@NotNull
public NativeBytesStore<Underlying> writeLong(long offset,
                                                       long i64)

Specified by:

writeLong in interface RandomDataOutput<NativeBytesStore<Underlying>>

writeOrderedLong

@NotNull
public NativeBytesStore<Underlying> writeOrderedLong(long offset,
                                                              long i)

Specified by:

writeOrderedLong in interface RandomDataOutput<NativeBytesStore<Underlying>>

writeFloat

@NotNull
public NativeBytesStore<Underlying> writeFloat(long offset,
                                                        float f)

Specified by:

writeFloat in interface RandomDataOutput<NativeBytesStore<Underlying>>

writeDouble

@NotNull
public NativeBytesStore<Underlying> writeDouble(long offset,
                                                         double d)

Specified by:

writeDouble in interface RandomDataOutput<NativeBytesStore<Underlying>>

write

@NotNull
public NativeBytesStore<Underlying> write(long offsetInRDO,
                                                   byte[] bytes,
                                                   int offset,
                                                   int length)

Specified by:

write in interface RandomDataOutput<NativeBytesStore<Underlying>>

write

public void write(long offsetInRDO,
                  @NotNull
                  ByteBuffer bytes,
                  int offset,
                  int length)

Specified by:

write in interface RandomDataOutput<NativeBytesStore<Underlying>>

write

@NotNull
public NativeBytesStore<Underlying> write(long offsetInRDO,
                                                   @NotNull
                                                   RandomDataInput bytes,
                                                   long offset,
                                                   long length)

Specified by:

write in interface RandomDataOutput<NativeBytesStore<Underlying>>

address

public long address(long offset)
             throws UnsupportedOperationException

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

toString

@NotNull
public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

nativeRead

public void nativeRead(long position,
                       long address,
                       long size)

Description copied from interface: RandomDataInput

expert level method for copying data to native memory.

Specified by:

nativeRead in interface RandomDataInput

Parameters:

position - within the ByteStore to copy.

address - in native memory

size - in bytes

nativeWrite

public void nativeWrite(long address,
                        long position,
                        long size)

Description copied from interface: RandomDataOutput

expert level method to copy data from native memory into the BytesStore

Specified by:

nativeWrite in interface RandomDataOutput<NativeBytesStore<Underlying>>

Parameters:

address - in native memory to copy from

position - in BytesStore to copy to

size - in bytes

readIncompleteLong

public long readIncompleteLong(long offset)

Specified by:

readIncompleteLong in interface RandomDataInput

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

setAddress

public void setAddress(long address)

start

public long start()

Returns:

The smallest position allowed in this buffer.

readPosition

public long readPosition()

writePosition

public long writePosition()

readRemaining

public long readRemaining()

writeRemaining

public long writeRemaining()

readLimit

public long readLimit()

Returns:

the highest offset or position allowed for this buffer.

writeLimit

public long writeLimit()

byteOrder

public ByteOrder byteOrder()