net.openhft.chronicle.bytes

Class MappedBytes

java.lang.Object

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

net.openhft.chronicle.bytes.MappedBytes

All Implemented Interfaces:

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

Direct Known Subclasses:

CheckingMappedBytes

public class MappedBytes
extends AbstractBytes<Void>

Bytes to wrap memory mapped data.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CHECKING

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

bytesStore, isPresent, readPosition, writeLimit, writePosition

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

DEFAULT_BYTE_BUFFER_CAPACITY, MAX_CAPACITY

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

charToString

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MappedBytes(MappedFile mappedFile)

Method Summary

Modifier and Type	Method and Description
Bytes<Void>	appendUtf8(CharSequence cs, int start, int length)
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.
BytesStore<Bytes<Void>,Void>	copy()
boolean	isElastic()
static MappedBytes	mappedBytes(File file, long chunkSize)
static MappedBytes	mappedBytes(File file, long chunkSize, long overlapSize)
static MappedBytes	mappedBytes(MappedFile rw)
static MappedBytes	mappedBytes(String filename, long chunkSize)
MappedFile	mappedFile()
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.
protected void	performRelease()
void	rawCopy(BytesStore bytes, long offset, long length)
protected void	readCheckOffset(long offset, long adding, boolean given)
default Reader	reader() Access these bytes as an ISO-8859-1 encoded Reader
default long	readRemaining()
long	realCapacity()
long	refCount()
void	setNewChunkListener(NewChunkListener listener)
default boolean	skipTo(StopCharTester tester) Skip text until a terminating character is reached.
long	start()
MappedBytes	withSizes(long chunkSize, long overlapSize)
Bytes<Void>	write(BytesStore bytes, long offset, long length) Write all data or fail.
MappedBytes	write8bit(CharSequence s, int start, int length)
protected void	writeCheckOffset(long offset, long adding)
default long	writeRemaining()

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

address, bytesStore, clear, clearAndPad, compact, compareAndSwapInt, compareAndSwapLong, equals, equalsBytes, hashCode, isPresent, isPresent, lastDecimalPlaces, lastDecimalPlaces, move, 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, release, reserve, 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, writeSome, 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.Bytes

allocateDirect, allocateDirect, allocateElasticDirect, allocateElasticDirect, bytesForRead, elasticByteBuffer, elasticByteBuffer, elasticByteBuffer, ensureCapacity, expect, expect, from, fromHexString, isClear, isEmpty, isEqual, 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, byteCheckSum, bytesForWrite, charAt, contentEquals, copyTo, copyTo, empty, endsWith, equalBytes, inside, isNative, length, longCheckSum, nativePointer, startsWith, subSequence, to8bitString, toDebugString, toDebugString, wrap, wrap, wrap, wrap, writeMaxLong, zeroOut

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

addAndGetDouble, addAndGetFloat, addAndGetInt, addAndGetLong, compareUtf8, copyTo, copyTo, createCharToString, findByte, parseLong, printable, read, readBoolean, readIncompleteLong, 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, 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.StreamingDataInput

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

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

append, append, append, append, append, append, append, append8bit, append8bit, appendBase, 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, writeInt24, writePositionRemaining, writeSome, 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

Field Detail

CHECKING

public static boolean CHECKING

Constructor Detail

MappedBytes

protected MappedBytes(MappedFile mappedFile)
               throws IllegalStateException

Throws:

IllegalStateException

Method Detail

mappedBytes

@NotNull
public static MappedBytes mappedBytes(@NotNull
                                               String filename,
                                               long chunkSize)
                                        throws FileNotFoundException,
                                               IllegalStateException

Throws:

FileNotFoundException

IllegalStateException

mappedBytes

@NotNull
public static MappedBytes mappedBytes(@NotNull
                                               File file,
                                               long chunkSize)
                                        throws FileNotFoundException,
                                               IllegalStateException

Throws:

FileNotFoundException

IllegalStateException

mappedBytes

@NotNull
public static MappedBytes mappedBytes(@NotNull
                                               File file,
                                               long chunkSize,
                                               long overlapSize)
                                        throws FileNotFoundException,
                                               IllegalStateException

Throws:

FileNotFoundException

IllegalStateException

mappedBytes

@NotNull
public static MappedBytes mappedBytes(MappedFile rw)

setNewChunkListener

public void setNewChunkListener(NewChunkListener listener)

mappedFile

public MappedFile mappedFile()

withSizes

public MappedBytes withSizes(long chunkSize,
                             long overlapSize)

copy

public BytesStore<Bytes<Void>,Void> copy()

Returns:

a copy of this Bytes from position() to limit().

capacity

public long capacity()

Specified by:

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

Overrides:

capacity in class AbstractBytes<Void>

Returns:

The maximum limit you can set.

realCapacity

public long realCapacity()

Specified by:

realCapacity in interface Bytes<Void>

Specified by:

realCapacity in interface BytesStore<Bytes<Void>,Void>

Specified by:

realCapacity in interface RandomDataInput

Overrides:

realCapacity in class AbstractBytes<Void>

Returns:

if isElastic, this can be much lower than the virtual capacity().

refCount

public long refCount()

Specified by:

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

Overrides:

refCount in class AbstractBytes<Void>

readCheckOffset

protected void readCheckOffset(long offset,
                               long adding,
                               boolean given)
                        throws BufferUnderflowException,
                               net.openhft.chronicle.core.io.IORuntimeException

Throws:

BufferUnderflowException

net.openhft.chronicle.core.io.IORuntimeException

writeCheckOffset

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

Throws:

BufferOverflowException

net.openhft.chronicle.core.io.IORuntimeException

start

public long start()

Overrides:

start in class AbstractBytes<Void>

Returns:

The smallest position allowed in this buffer.

performRelease

protected void performRelease()

isElastic

public boolean isElastic()

Returns:

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

write

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

Description copied from interface: StreamingDataOutput

Write all data or fail.

Throws:

net.openhft.chronicle.core.io.IORuntimeException

BufferUnderflowException

BufferOverflowException

rawCopy

public void rawCopy(@NotNull
                    BytesStore bytes,
                    long offset,
                    long length)
             throws BufferOverflowException,
                    BufferUnderflowException

Throws:

BufferOverflowException

BufferUnderflowException

write8bit

public MappedBytes write8bit(CharSequence s,
                             int start,
                             int length)

appendUtf8

public Bytes<Void> appendUtf8(CharSequence cs,
                              int start,
                              int length)
                       throws BufferOverflowException,
                              IllegalArgumentException,
                              net.openhft.chronicle.core.io.IORuntimeException

Throws:

BufferOverflowException

IllegalArgumentException

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