net.openhft.chronicle.bytes

Class NativeBytes<U>

java.lang.Object

net.openhft.chronicle.core.io.AbstractReferenceCounted

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

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

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

Type Parameters:

U - This represents the underlying type that the byte buffers are intended to represent.

All Implemented Interfaces:

Appendable, CharSequence, Comparable<CharSequence>, Byteable, Bytes<U>, BytesIn<U>, BytesOut<U>, BytesPrepender<Bytes<U>>, BytesStore<Bytes<U>,U>, ByteStringAppender<Bytes<U>>, ByteStringParser<Bytes<U>>, HexDumpBytesDescription<BytesOut<U>>, net.openhft.chronicle.bytes.internal.HasUncheckedRandomDataInput, RandomDataInput, RandomDataOutput<Bytes<U>>, DecimalAppender, StreamingCommon<Bytes<U>>, StreamingDataInput<Bytes<U>>, StreamingDataOutput<Bytes<U>>, net.openhft.chronicle.core.io.Monitorable, net.openhft.chronicle.core.io.ReferenceCounted, net.openhft.chronicle.core.io.ReferenceCountedTracer, net.openhft.chronicle.core.io.ReferenceOwner, net.openhft.chronicle.core.io.SingleThreadedChecked

Direct Known Subclasses:

GuardedNativeBytes

public class NativeBytes<U>
extends VanillaBytes<U>

NativeBytes is a subclass of VanillaBytes which can wrap either a ByteBuffer or malloc'ed memory. It provides flexibility in handling byte arrays which can be of arbitrary sizes and can grow dynamically. The class is called NativeBytes because it deals with 'native' ByteBuffers or memory directly allocated from the operating system which is on heap. It is also capable of handling memory allocation, resizing, and checking boundaries to prevent overflows.

The class can be parameterized with a type <U> which represents the underlying type that the byte buffers are intended to represent. This provides a way to use NativeBytes for any type that can be represented as bytes.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	capacity

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

bytesStore, isPresent, readPosition, writeLimit

Fields inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted

referenceCounted, WARN_COUNT, WARN_NS

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

DEFAULT_BYTE_BUFFER_CAPACITY, MAX_CAPACITY, MAX_HEAP_CAPACITY

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

JAVA9_STRING_CODER_LATIN, JAVA9_STRING_CODER_UTF16

Fields inherited from interface net.openhft.chronicle.core.io.SingleThreadedChecked

DISABLE_SINGLE_THREADED_CHECK

Constructor Summary

Constructors

Constructor and Description
NativeBytes(@NotNull BytesStore<?,?> store) Constructs a new instance of NativeBytes with the specified BytesStore and the store's capacity.
NativeBytes(@NotNull BytesStore<?,?> store, long capacity) Constructs a new instance of NativeBytes with the specified BytesStore and capacity.

Method Summary

Modifier and Type	Method and Description
static boolean	areNewGuarded() Checks if new NativeBytes instances will be guarded or not.
protected void	bytesStore(@NotNull BytesStore<?,U> bytesStore)
void	bytesStore(@NotNull BytesStore byteStore, long offset, long length) Sets the reference to a data type that points to the underlying ByteStore.
long	capacity() Provides the maximum limit that can be set for the ByteStore.
void	ensureCapacity(long desiredCapacity) Ensures that this Bytes object has the capacity to accommodate the specified amount of data.
boolean	isElastic() Checks if this Bytes object is elastic, meaning it can dynamically resize when more data is written than its current Bytes.realCapacity().
boolean	isEqual(long start, long length, String s) Returns if a specified portion of this BytesStore is equal to a specified String.
protected static <T> long	maxCapacityFor(@NotNull BytesStore<?,T> bs)
static @NotNull NativeBytes<Void>	nativeBytes() Creates a new instance of NativeBytes with an empty BytesStore and maximum capacity.
static @NotNull NativeBytes<Void>	nativeBytes(long initialCapacity) Creates a new instance of NativeBytes with a specific initial capacity.
long	readRemaining() Calculates the number of bytes remaining that can be read from the current read position.
static void	resetNewGuarded() Resets the guarded state for new NativeBytes instances to its default value.
static boolean	setNewGuarded(boolean guarded) Sets the guarded state for new NativeBytes instances.
static <T> @NotNull NativeBytes<T>	wrapWithNativeBytes(@NotNull BytesStore<?,T> bs, long capacity) Wraps the provided BytesStore with a new instance of NativeBytes with the specified capacity.
@NotNull Bytes<U>	writeByte(byte i8) Writes a byte to the data stream.
protected void	writeCheckOffset(long offset, long adding)
@NotNull Bytes<U>	writeLong(long i64) Writes a long integer to the data stream.
protected long	writeOffsetPositionMoved(long adding, long advance)

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

append, append8bit, append8bit, append8bit, append8bit0, appendUtf8, appendUtf8, byteCheckSum, bytesForRead, compareTo, copy, equalBytes, findByte, isEqual, maxSize, offset, optimisedWrite, parseLong, read, read8Bit, readVolatileLong, realCapacity, toString, toString0, toTemporaryDirectByteBuffer, vanillaBytes, wrap, write, write, write

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

acquireUncheckedInput, addressForRead, addressForWrite, addressForWritePosition, append, append, append, append, append, append, appendAndReturnLength, byteCheckSum, byteCheckSum, bytesStore, canReadDirect, canWriteDirect, clear, clearAndPad, compact, compareAndSwapInt, compareAndSwapLong, copyTo, decimaliser, decimaliser, equals, fpAppend0, fpAppend0, hashCode, isDirectMemory, isImmutableEmptyByteStore, lastDecimalPlaces, lastDecimalPlaces, lastNumberHadDigits, lastNumberHadDigits, length, lenient, lenient, move, nativeRead, nativeWrite, peekUnsignedByte, peekUnsignedByte, performRelease, prewrite, prewrite, prewriteByte, prewriteInt, prewriteLong, prewriteOffsetPositionMoved, prewriteShort, read, read, readByte, readByte, readCheckOffset, readDouble, readDouble, readFloat, readFloat, readInt, readInt, readLimit, readLimit, readLong, readLong, readOffsetPositionMoved, readPosition, readPosition, readPositionForHeader, readShort, readShort, readSkip, readUnsignedByte, readUnsignedByte, readVolatileByte, readVolatileInt, readVolatileInt, readVolatileLong, readVolatileShort, safeCopySize, start, startsWith, testAndSetInt, uncheckedReadSkipBackOne, uncheckedReadSkipOne, uncheckedReadUnsignedByte, uncheckedWritePosition, underlyingObject, unmonitor, write, write, write, write, write, write, write8bit, write8bit, write8bit, write8bit, writeBoolean, writeByte, writeDouble, writeDouble, writeDoubleAndInt, writeFloat, writeFloat, writeInt, writeInt, writeIntAdv, writeLimit, writeLimit, writeLong, writeLongAdv, writeOffsetPositionMoved, writeOrderedInt, writeOrderedInt, writeOrderedLong, writeOrderedLong, writePosition, writePosition, writeShort, writeShort, writeSkip, writeSome, writeVolatileByte, writeVolatileInt, writeVolatileLong, writeVolatileShort

Methods inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted

addReferenceChangeListener, assertReferencesReleased, backgroundPerformRelease, canReleaseInBackground, createdHere, disableReferenceTracing, enableReferenceTracing, refCount, referenceCountedUnmonitored, referenceId, release, releaseLast, removeReferenceChangeListener, reserve, reserveTransfer, singleThreadedCheckDisabled, singleThreadedCheckReset, threadSafetyCheck, throwExceptionIfNotReleased, throwExceptionIfReleased, tryReserve, unmonitor, warnAndReleaseIfNotReleased

Methods inherited from class java.lang.Object

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

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

address, bytesStore, lock, tryLock

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

allocateDirect, allocateDirect, allocateElasticDirect, allocateElasticDirect, allocateElasticOnHeap, allocateElasticOnHeap, bytesForWrite, copyTo, copyTo, directFrom, elasticByteBuffer, elasticByteBuffer, elasticByteBuffer, elasticHeapByteBuffer, elasticHeapByteBuffer, empty, forFieldGroup, from, from, fromDirect, fromHexString, indexOf, indexOf, isClear, readMarshallableLength16, readWithLength, readWrite, safeLimit, sharedMemory, toHexString, toHexString, toHexString, toString, toString, toString, unchecked, unchecked, unwrite, valueOf, wrapForRead, wrapForRead, wrapForWrite, wrapForWrite, write, writeMarshallableLength16

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

addAndGetDouble, addAndGetDoubleNotAtomic, addAndGetFloat, addAndGetFloatNotAtomic, addAndGetInt, addAndGetIntNotAtomic, addAndGetLong, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, charAt, cipher, cipher, compareAndSwapDouble, compareAndSwapFloat, contentEquals, elasticByteBuffer, endsWith, follow, forFields, from, hash, inside, inside, isEmpty, lazyNativeBytesStoreWithFixedCapacity, nativePointer, nativeStore, nativeStoreFrom, nativeStoreWithFixedCapacity, startsWith, subSequence, to8bitString, toDebugString, toDebugString, wrap, wrap, wrap, writeMaxInt, writeMaxLong, zeroOut

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 java.lang.CharSequence

chars, codePoints

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

bytesMethodReader, bytesMethodReaderBuilder, readObject

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

canReadDirect, compareUtf8, copyTo, fastHash, parseLong, peekVolatileInt, printable, readBoolean, readIncompleteLong, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileDouble, readVolatileFloat, subBytes, toByteArray

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

parse8bit, parse8bit, parse8bit, parse8bit, parse8bit, parseBigDecimal, parseBoolean, parseBoolean, parseDouble, parseFlexibleLong, parseFloat, parseInt, parseLongDecimal, parseUtf8, parseUtf8, parseUtf8, reader, skipTo

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

inputStream, parseHexLong, parseUtf8, parseUtf8, rawReadByte, rawReadInt, rawReadLong, read, read, read, read, read8bit, read8bit, read8bit, readBigDecimal, readBigInteger, readBoolean, readChar, readEnum, readHistogram, readIncompleteLong, readInt24, readLimitToCapacity, readPositionRemaining, readPositionUnlimited, readStopBit, readStopBitChar, readStopBitDecimal, readStopBitDouble, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8, readUtf8, readUtf8, readWithLength, readWithLength, readWithLength0, unsafeRead, unsafeReadObject, unsafeReadObject

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

bytesMethodWriter, writeObject

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

append, append, append, append, append8bit, append8bit, appendBase, appendBase16, appendBase16, appendDateMillis, appendDecimal, appendTimeMillis, writer

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

appendUtf8, appendUtf8, appendUtf8, appendUtf8, copyFrom, outputStream, rawWriteByte, rawWriteInt, rawWriteLong, unsafeWrite, unsafeWriteObject, unsafeWriteObject, write, write, write, write8bit, write8bit, write8bit, writeBigDecimal, writeBigInteger, writeChar, writeEnum, writeHistogram, writeInt24, writePositionForHeader, writePositionRemaining, writeStopBit, writeStopBit, writeStopBit, writeStopBitDecimal, writeUnsignedByte, writeUnsignedInt, writeUnsignedInt24, writeUnsignedShort, writeUtf8, writeUtf8, writeWithLength

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

prepend

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

adjustHexDumpIndentation, retainedHexDumpDescription, writeHexDumpDescription

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

singleThreadedCheckDisabled, singleThreadedCheckReset

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

onReleased

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

unmonitor

Field Detail

capacity

protected long capacity

Constructor Detail

NativeBytes

public NativeBytes(@NotNull
                   @NotNull BytesStore<?,?> store,
                   long capacity)
            throws IllegalArgumentException,
                   net.openhft.chronicle.core.io.ClosedIllegalStateException

Constructs a new instance of NativeBytes with the specified BytesStore and capacity.

Parameters:

store - the BytesStore to be used for the newly constructed instance

capacity - the capacity to be used for the newly constructed instance

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalArgumentException

NativeBytes

public NativeBytes(@NotNull
                   @NotNull BytesStore<?,?> store)
            throws IllegalArgumentException,
                   net.openhft.chronicle.core.io.ClosedIllegalStateException

Constructs a new instance of NativeBytes with the specified BytesStore and the store's capacity.

Parameters:

store - the BytesStore to be used for the newly constructed instance

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalArgumentException

Method Detail

areNewGuarded

public static boolean areNewGuarded()

Checks if new NativeBytes instances will be guarded or not.

Returns:

true if new NativeBytes instances will be guarded, false otherwise

setNewGuarded

public static boolean setNewGuarded(boolean guarded)

Sets the guarded state for new NativeBytes instances.

Parameters:

guarded - true to turn on guarding for new NativeBytes instances, false to turn it off

Returns:

true if the operation is successful, false otherwise

resetNewGuarded

public static void resetNewGuarded()

Resets the guarded state for new NativeBytes instances to its default value.

nativeBytes

@NotNull
public static @NotNull NativeBytes<Void> nativeBytes()

Creates a new instance of NativeBytes with an empty BytesStore and maximum capacity.

Returns:

A new instance of NativeBytes.

Throws:

AssertionError - If there's an error during the wrapping process.

nativeBytes

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

Creates a new instance of NativeBytes with a specific initial capacity.

Parameters:

initialCapacity - The initial capacity of the NativeBytes instance.

Returns:

A new instance of NativeBytes.

Throws:

IllegalArgumentException - If the initial capacity is not valid.

AssertionError - If there's an error during the wrapping process.

wrapWithNativeBytes

@NotNull
public static <T> @NotNull NativeBytes<T> wrapWithNativeBytes(@NotNull
                                                                       @NotNull BytesStore<?,T> bs,
                                                                       long capacity)
                                                                throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                                       IllegalArgumentException

Wraps the provided BytesStore with a new instance of NativeBytes with the specified capacity.

Parameters:

bs - The BytesStore to wrap.

capacity - The capacity of the new NativeBytes instance.

Returns:

A new instance of NativeBytes.

Throws:

IllegalArgumentException - If the provided capacity is not valid.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

maxCapacityFor

protected static <T> long maxCapacityFor(@NotNull
                                         @NotNull BytesStore<?,T> bs)

capacity

public long capacity()

Description copied from interface: BytesStore

Provides the maximum limit that can be set for the ByteStore.

Specified by:

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

Overrides:

capacity in class AbstractBytes<U>

Returns:

the maximum capacity of the ByteStore

writeCheckOffset

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

Overrides:

writeCheckOffset in class AbstractBytes<U>

Throws:

BufferOverflowException

net.openhft.chronicle.core.io.ClosedIllegalStateException

net.openhft.chronicle.core.io.ThreadingIllegalStateException

ensureCapacity

public void ensureCapacity(long desiredCapacity)
                    throws IllegalArgumentException,
                           net.openhft.chronicle.core.io.ClosedIllegalStateException,
                           net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: Bytes

Ensures that this Bytes object has the capacity to accommodate the specified amount of data.

If this Bytes object is elastic and doesn't have enough capacity, it will be resized. If it is not elastic and doesn't have enough capacity, a DecoratedBufferOverflowException will be thrown.

Parameters:

desiredCapacity - The minimum capacity, in bytes, that is required.

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalArgumentException

isElastic

public boolean isElastic()

Description copied from interface: Bytes

Checks if this Bytes object is elastic, meaning it can dynamically resize when more data is written than its current Bytes.realCapacity().

Elastic Bytes objects can automatically grow to accommodate additional data, whereas non-elastic ones have a fixed capacity.

Specified by:

isElastic in interface Bytes<U>

Overrides:

isElastic in class VanillaBytes<U>

Returns:

true if this Bytes object is elastic; false otherwise.

isEqual

public boolean isEqual(long start,
                       long length,
                       String s)

Description copied from interface: BytesStore

Returns if a specified portion of this BytesStore is equal to a specified String. The portion is specified with its offset and length.

Parameters:

start - the portion offset

length - the number of bytes from this BytesStore that should be compared to s

s - the String to compare to

Returns:

true if the specified portion of this BytesStore is equal to s

bytesStore

protected void bytesStore(@NotNull
                          @NotNull BytesStore<?,U> bytesStore)

Overrides:

bytesStore in class AbstractBytes<U>

bytesStore

public void bytesStore(@NotNull
                       @NotNull BytesStore byteStore,
                       long offset,
                       long length)
                throws IllegalArgumentException,
                       BufferUnderflowException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: Byteable

Sets the reference to a data type that points to the underlying ByteStore.

Specified by:

bytesStore in interface Byteable

Overrides:

bytesStore in class VanillaBytes<U>

Parameters:

byteStore - the fixed-point ByteStore

offset - the offset within the ByteStore, indicating the starting point of the memory section

length - the length of the memory section within the ByteStore

Throws:

IllegalArgumentException - If the provided arguments are invalid

BufferUnderflowException - If the new memory section starts before the start of the ByteStore

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

writeOffsetPositionMoved

protected long writeOffsetPositionMoved(long adding,
                                        long advance)
                                 throws BufferOverflowException,
                                        net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                        net.openhft.chronicle.core.io.ThreadingIllegalStateException

Overrides:

writeOffsetPositionMoved in class AbstractBytes<U>

Throws:

BufferOverflowException

net.openhft.chronicle.core.io.ClosedIllegalStateException

net.openhft.chronicle.core.io.ThreadingIllegalStateException

writeByte

@NotNull
public @NotNull Bytes<U> writeByte(byte i8)
                                     throws BufferOverflowException,
                                            net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                            net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: StreamingDataOutput

Writes a byte to the data stream.

Specified by:

writeByte in interface StreamingDataOutput<Bytes<U>>

Overrides:

writeByte in class AbstractBytes<U>

Parameters:

i8 - The byte to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

writeLong

@NotNull
public @NotNull Bytes<U> writeLong(long i64)
                                     throws BufferOverflowException,
                                            net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                            net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: StreamingDataOutput

Writes a long integer to the data stream.

Specified by:

writeLong in interface StreamingDataOutput<Bytes<U>>

Overrides:

writeLong in class AbstractBytes<U>

Parameters:

i64 - The long integer to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

readRemaining

public long readRemaining()

Calculates the number of bytes remaining that can be read from the current read position.

If the resource is closed, the returned value is unspecified.

Returns:

The number of bytes that can still be read.