net.openhft.chronicle.bytes

Class NativeBytes<Underlying>

java.lang.Object

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

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

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

All Implemented Interfaces:

Closeable, Appendable, AutoCloseable, CharSequence, Byteable<Bytes<Underlying>,Underlying>, Bytes<Underlying>, BytesPrepender<Bytes<Underlying>>, BytesStore<Bytes<Underlying>,Underlying>, ByteStringAppender<Bytes<Underlying>>, RandomDataInput, RandomDataOutput<Bytes<Underlying>>, StreamingDataInput<Bytes<Underlying>>, StreamingDataOutput<Bytes<Underlying>>, net.openhft.chronicle.core.ReferenceCounted

public class NativeBytes<Underlying>
extends VanillaBytes<Underlying>

Elastic native memory accessor which can wrap either a direct ByteBuffer or malloc'ed memory.

Field Summary

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

bytesStore, isPresent, readPosition, writeLimit, writePosition

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

MAX_CAPACITY

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

charToString

Method Summary

Modifier and Type	Method and Description
default ByteOrder	byteOrder()
long	capacity()
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.
static BytesStore<Bytes<Void>,Void>	copyOf(Bytes bytes)
void	ensureCapacity(long size) grow the buffer if the buffer is elastic, if the buffer is not elastic and there is not enough capacity then this method will throws BufferOverflowException
boolean	isElastic()
static NativeBytes<Void>	nativeBytes()
static NativeBytes<Void>	nativeBytes(long initialCapacity)
default void	parse8bit(Appendable buffer, StopCharsTester stopCharsTester) parse text with ISO-8859-1 decoding as character terminated.
default void	parse8bit(Appendable buffer, StopCharTester stopCharTester) parse text with ISO-8859-1 decoding as character terminated.
default Boolean	parseBoolean(StopCharTester tester) Return true or false, or null if it could not be detected as true or false.
default double	parseDouble() parse text as a double decimal.
default long	parseLong() parse text as a long integer.
default long	parseLongDecimal() Parse the significant digits of a decimal number.
default void	parseUTF(Appendable buffer, StopCharsTester stopCharsTester) Deprecated.
default void	parseUTF(Appendable buffer, StopCharTester stopCharTester) Deprecated.
default String	parseUTF(StopCharTester stopCharTester) Deprecated.
default void	parseUtf8(Appendable buffer, StopCharsTester stopCharsTester) parse text with UTF-8 decoding as one or two character terminated.
default void	parseUtf8(Appendable buffer, StopCharTester stopCharTester) parse text with UTF-8 decoding as character terminated.
default String	parseUtf8(StopCharTester stopCharTester) parse text with UTF-8 decoding as character terminated.
default Reader	reader() Access these bytes as an ISO-8859-1 encoded Reader
long	readIncompleteLong(long offset) Read a long which is zero padded (high bytes) if the available bytes is less than 8.
default long	readRemaining()
byte	readVolatileByte(long offset) Read a 8-bit byte from memory with a load barrier.
int	readVolatileInt(long offset) Read a 32-bit int from memory with a load barrier.
long	readVolatileLong(long offset) Read a 64-bit long from memory with a load barrier.
short	readVolatileShort(long offset) Read a 16-bit short from memory with a load barrier.
default boolean	skipTo(StopCharTester tester) Skip text until a terminating character is reached.
Bytes<Underlying>	write(byte[] bytes, int offset, int length)
Bytes<Underlying>	write(BytesStore bytes, long offset, long length)
protected void	writeCheckOffset(long offset, long adding)
default long	writeRemaining()

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

append, appendUtf8, byteCheckSum, bytesForRead, bytesStore, copy, equalBytes, isEqual, maxSize, offset, read8Bit, realCapacity, toTemporaryDirectByteBuffer, vanillaBytes, write, write8bit

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

address, bytesStore, clear, clearAndPad, compareAndSwapInt, compareAndSwapLong, equals, equalsBytes, hashCode, isPresent, isPresent, lastDecimalPlaces, lastDecimalPlaces, nativeRead, nativeRead, nativeWrite, nativeWrite, peekUnsignedByte, prewrite, prewrite, prewriteByte, prewriteInt, prewriteLong, prewriteOffsetPositionMoved, prewriteShort, readByte, readByte, readDouble, readDouble, readFloat, readFloat, readInt, readInt, readLimit, readLimit, readLong, readLong, readOffsetPositionMoved, readPosition, readPosition, readShort, readShort, readSkip, readUnsignedByte, readVolatileInt, readVolatileLong, refCount, release, reserve, start, toString, underlyingObject, write, write, write, write, writeByte, writeByte, writeDouble, writeDouble, writeFloat, writeFloat, writeInt, writeInt, writeLimit, writeLimit, writeLong, writeLong, writeOffsetPositionMoved, writeOrderedInt, writeOrderedInt, writeOrderedLong, writeOrderedLong, writePosition, writePosition, writeShort, writeShort, writeSkip, writeVolatileByte, writeVolatileInt, writeVolatileLong, writeVolatileShort

Methods inherited from class java.lang.Object

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

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

bytesStore

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

allocateDirect, allocateDirect, allocateElasticDirect, allocateElasticDirect, elasticByteBuffer, elasticByteBuffer, elasticByteBuffer, empty, expect, expect, from, fromHexString, isClear, safeLimit, toHexString, toHexString, toHexString, toString, toString, toString, unchecked, wrapForRead, wrapForRead, wrapForRead, wrapForWrite, wrapForWrite

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

addAndGetByteNotAtomic, addAndGetDoubleNotAtomic, addAndGetFloatNotAtomic, addAndGetIntNotAtomic, addAndGetLongNotAtomic, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, addAndGetUnsignedIntNotAtomic, addAndGetUnsignedShortNotAtomic, bytesForWrite, charAt, contentEquals, copyTo, copyTo, endsWith, inside, isNative, length, longCheckSum, nativePointer, startsWith, subSequence, to8bitString, toDebugString, toDebugString, wrap, wrap, wrap, wrap, zeroOut

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

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

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

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

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

inputStream, parseHexLong, parseUTF, parseUtf8, parseWithLength, read, read, read, read, read8bit, read8bit, read8bit, read8bit, readBoolean, readEnum, readStopBit, readStopBitDouble, readUnsignedInt, readUnsignedShort, readUtf8, readUtf8, readUTFΔ, readUTFΔ, readWithLength

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

append, append, append, append, append, append, append8bit, append8bit, appendDateMillis, appendDecimal, appendTimeMillis, writer

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

appendUtf8, appendUtf8, appendUtf8, copyFrom, outputStream, write, write, write, write, write8bit, write8bit, write8bit, writeBoolean, writeEnum, writeStopBit, writeStopBit, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUTFΔ

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

close, release, releaseAll, tryReserve

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

closeQuietly, notifyClosing

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

prepend

Method Detail

nativeBytes

@NotNull
public static NativeBytes<Void> nativeBytes()

nativeBytes

@NotNull
public static NativeBytes<Void> nativeBytes(long initialCapacity)
                                              throws IllegalArgumentException

Throws:

IllegalArgumentException

copyOf

public static BytesStore<Bytes<Void>,Void> copyOf(@NotNull
                                                  Bytes bytes)

capacity

public long capacity()

Specified by:

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

Overrides:

capacity in class AbstractBytes<Underlying>

Returns:

The maximum limit you can set.

writeCheckOffset

protected void writeCheckOffset(long offset,
                                long adding)
                         throws BufferOverflowException,
                                IllegalArgumentException,
                                net.openhft.chronicle.core.io.IORuntimeException

Throws:

BufferOverflowException

IllegalArgumentException

net.openhft.chronicle.core.io.IORuntimeException

ensureCapacity

public void ensureCapacity(long size)
                    throws IllegalArgumentException,
                           net.openhft.chronicle.core.io.IORuntimeException

Description copied from interface: Bytes

grow the buffer if the buffer is elastic, if the buffer is not elastic and there is not enough capacity then this method will throws BufferOverflowException

Parameters:

size - the capacity that you required

Throws:

IllegalArgumentException - if the buffer is not elastic and there is not enough space

IORuntimeException - if an error occured trying to resize the underlying buffer.

net.openhft.chronicle.core.io.IORuntimeException

readVolatileByte

public byte readVolatileByte(long offset)
                      throws BufferUnderflowException,
                             net.openhft.chronicle.core.io.IORuntimeException

Description copied from interface: RandomDataInput

Read a 8-bit byte from memory with a load barrier.

Parameters:

offset - to read

Returns:

the byte value

Throws:

BufferUnderflowException - if the offset is outside the limits of the Bytes

IORuntimeException - if an error occurred trying to obtain the data.

net.openhft.chronicle.core.io.IORuntimeException

readVolatileShort

public short readVolatileShort(long offset)
                        throws BufferUnderflowException,
                               net.openhft.chronicle.core.io.IORuntimeException

Description copied from interface: RandomDataInput

Read a 16-bit short from memory with a load barrier.

Parameters:

offset - to read

Returns:

the short value

Throws:

BufferUnderflowException - if the offset is outside the limits of the Bytes

IORuntimeException - if an error occurred trying to obtain the data.

net.openhft.chronicle.core.io.IORuntimeException

readVolatileInt

public int readVolatileInt(long offset)
                    throws BufferUnderflowException,
                           net.openhft.chronicle.core.io.IORuntimeException

Description copied from interface: RandomDataInput

Read a 32-bit int from memory with a load barrier.

Parameters:

offset - to read

Returns:

the int value

Throws:

BufferUnderflowException - if the offset is outside the limits of the Bytes

IORuntimeException - if an error occurred trying to obtain the data.

net.openhft.chronicle.core.io.IORuntimeException

readVolatileLong

public long readVolatileLong(long offset)
                      throws BufferUnderflowException,
                             net.openhft.chronicle.core.io.IORuntimeException

Description copied from interface: RandomDataInput

Read a 64-bit long from memory with a load barrier.

Parameters:

offset - to read

Returns:

the long value

Throws:

BufferUnderflowException - if the offset is outside the limits of the Bytes

IORuntimeException - if an error occurred trying to obtain the data.

net.openhft.chronicle.core.io.IORuntimeException

isElastic

public boolean isElastic()

Specified by:

isElastic in interface Bytes<Underlying>

Overrides:

isElastic in class VanillaBytes<Underlying>

Returns:

can the Bytes resize when more data is written than it's realCapacity()

readIncompleteLong

public long readIncompleteLong(long offset)
                        throws net.openhft.chronicle.core.io.IORuntimeException

Description copied from interface: RandomDataInput

Read a long which is zero padded (high bytes) if the available bytes is less than 8. If the offset is at or beyond the readLimit, this will return 0L.

Parameters:

offset - to read from

Returns:

the long which might be padded.

Throws:

IORuntimeException - if an error occurred trying to obtain the data.

net.openhft.chronicle.core.io.IORuntimeException

write

@NotNull
public Bytes<Underlying> write(byte[] bytes,
                                        int offset,
                                        int length)
                                 throws BufferOverflowException,
                                        IllegalArgumentException,
                                        net.openhft.chronicle.core.io.IORuntimeException

Specified by:

write in interface StreamingDataOutput<Bytes<Underlying>>

Overrides:

write in class AbstractBytes<Underlying>

Throws:

BufferOverflowException

IllegalArgumentException

net.openhft.chronicle.core.io.IORuntimeException

write

@NotNull
public Bytes<Underlying> write(BytesStore bytes,
                                        long offset,
                                        long length)
                                 throws BufferOverflowException,
                                        IllegalArgumentException,
                                        BufferUnderflowException,
                                        net.openhft.chronicle.core.io.IORuntimeException

Specified by:

write in interface StreamingDataOutput<Bytes<Underlying>>

Overrides:

write in class VanillaBytes<Underlying>

Throws:

BufferOverflowException

IllegalArgumentException

BufferUnderflowException

net.openhft.chronicle.core.io.IORuntimeException

reader

public Reader reader()

Access these bytes as an ISO-8859-1 encoded Reader

Returns:

as a Reader

parseBoolean

public Boolean parseBoolean(@NotNull
                            StopCharTester tester)

Return true or false, or null if it could not be detected as true or false. Case is not important

false: f, false, n, no, 0

true: t, true, y, yes, 1

Parameters:

tester - to detect the end of the text.

Returns:

true, false, or null if neither.

parseUtf8

@NotNull
public String parseUtf8(@NotNull
                                 StopCharTester stopCharTester)

parse text with UTF-8 decoding as character terminated.

Parameters:

stopCharTester - to check if the end has been reached.

Returns:

the text as a String.

parseUTF

@Deprecated
public String parseUTF(@NotNull
                                   StopCharTester stopCharTester)

Deprecated.

parseUtf8

public void parseUtf8(@NotNull
                      Appendable buffer,
                      @NotNull
                      StopCharTester stopCharTester)

parse text with UTF-8 decoding as character terminated.

Parameters:

buffer - to populate

stopCharTester - to check if the end has been reached.

parseUTF

@Deprecated
public void parseUTF(@NotNull
                                 Appendable buffer,
                                 @NotNull
                                 StopCharTester stopCharTester)

Deprecated.

parseUtf8

public void parseUtf8(@NotNull
                      Appendable buffer,
                      @NotNull
                      StopCharsTester stopCharsTester)
               throws BufferUnderflowException,
                      BufferOverflowException,
                      net.openhft.chronicle.core.io.IORuntimeException

parse text with UTF-8 decoding as one or two character terminated.

Parameters:

buffer - to populate

stopCharsTester - to check if the end has been reached.

Throws:

BufferUnderflowException

BufferOverflowException

net.openhft.chronicle.core.io.IORuntimeException

parseUTF

@Deprecated
public void parseUTF(@NotNull
                                 Appendable buffer,
                                 @NotNull
                                 StopCharsTester stopCharsTester)
                          throws BufferUnderflowException,
                                 BufferOverflowException,
                                 net.openhft.chronicle.core.io.IORuntimeException

Deprecated.

Throws:

BufferUnderflowException

BufferOverflowException

net.openhft.chronicle.core.io.IORuntimeException

parse8bit

public void parse8bit(Appendable buffer,
                      @NotNull
                      StopCharTester stopCharTester)
               throws BufferUnderflowException,
                      BufferOverflowException,
                      net.openhft.chronicle.core.io.IORuntimeException

parse text with ISO-8859-1 decoding as character terminated.

Parameters:

buffer - to populate

stopCharTester - to check if the end has been reached.

Throws:

BufferUnderflowException

BufferOverflowException

net.openhft.chronicle.core.io.IORuntimeException

parse8bit

public void parse8bit(Appendable buffer,
                      @NotNull
                      StopCharsTester stopCharsTester)
               throws BufferUnderflowException,
                      BufferOverflowException,
                      net.openhft.chronicle.core.io.IORuntimeException

parse text with ISO-8859-1 decoding as character terminated.

Parameters:

buffer - to populate

stopCharsTester - to check if the end has been reached.

Throws:

BufferUnderflowException

BufferOverflowException

net.openhft.chronicle.core.io.IORuntimeException

parseLong

public long parseLong()
               throws BufferUnderflowException,
                      net.openhft.chronicle.core.io.IORuntimeException

parse text as a long integer. The terminating character is consumed.

Returns:

a long.

Throws:

BufferUnderflowException

net.openhft.chronicle.core.io.IORuntimeException

parseDouble

public double parseDouble()
                   throws BufferUnderflowException,
                          net.openhft.chronicle.core.io.IORuntimeException

parse text as a double decimal. The terminating character is consumed.

The number of decimal places can be retrieved with lastDecimalPlaces()

Returns:

a double.

Throws:

BufferUnderflowException

net.openhft.chronicle.core.io.IORuntimeException

parseLongDecimal

public long parseLongDecimal()
                      throws BufferUnderflowException

Parse the significant digits of a decimal number.

The number of decimal places can be retrieved with lastDecimalPlaces()

Returns:

the significant digits

Throws:

BufferUnderflowException

skipTo

public boolean skipTo(@NotNull
                      StopCharTester tester)
               throws net.openhft.chronicle.core.io.IORuntimeException

Skip text until a terminating character is reached.

Parameters:

tester - to stop at

Returns:

true if a terminating character was found, false if the end of the buffer was reached.

Throws:

net.openhft.chronicle.core.io.IORuntimeException

readRemaining

public long readRemaining()

Returns:

How many more bytes can we read.

writeRemaining

public long writeRemaining()

Returns:

How many more bytes can we written.

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