StreamingDataOutput (OpenHFT/Chronicle-Bytes 1.7.24 API)

All Known Subinterfaces:

Bytes<Underlying>, BytesOut<Underlying>, ByteStringAppender<B>

All Known Implementing Classes:

AbstractBytes, CheckingMappedBytes, MappedBytes, NativeBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes
```
public interface StreamingDataOutput<S extends StreamingDataOutput<S>>
```
Position based access. Once data has been read, the position() moves.
The use of this instance is single threaded, though the use of the data

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`long`	`address(long offset)` Obtain the underlying address.
`default S`	`appendUtf8(char[] chars, int offset, int length)`
`default S`	`appendUtf8(CharSequence cs)`
`default S`	`appendUtf8(CharSequence cs, int offset, int length)`
`default S`	`appendUtf8(int codepoint)`
`default ByteOrder`	`byteOrder()`
`Bytes`	`bytesForRead()`
`Bytes`	`bytesForWrite()`
`default long`	`capacity()`
`S`	`clear()` Set the readPosition= writePosition = start, writeLimit = 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.
`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.
`default void`	`copyFrom(InputStream input)`
`boolean`	`isDirectMemory()`
`void`	`nativeWrite(long address, long size)` This is an expert level method for writing out data to native memory.
`default OutputStream`	`outputStream()`
`default long`	`readLimit()`
`default long`	`readPosition()` The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()
`default long`	`readRemaining()`
`long`	`realCapacity()`
`boolean`	`sharedMemory()`
`default long`	`start()`
`default S`	`write(byte[] bytes)`
`S`	`write(byte[] bytes, int offset, int length)` Write all data or fail.
`default S`	`write(BytesStore bytes)` Write all data or fail.
`default S`	`write(BytesStore bytes, long offset, long length)` Write all data or fail.
`default S`	`write(CharSequence cs)`
`default S`	`write(CharSequence s, int start, int length)`
`default S`	`write8bit(BytesStore sdi)`
`default S`	`write8bit(CharSequence cs)`
`default S`	`write8bit(CharSequence s, int start, int length)`
`default S`	`write8bit(String s)`
`default void`	`writeBigDecimal(BigDecimal bd)`
`default void`	`writeBigInteger(BigInteger bi)`
`default S`	`writeBoolean(boolean flag)`
`S`	`writeByte(byte i8)`
`S`	`writeDouble(double d)`
`default <E extends Enum<E>> void`	`writeEnum(E e)`
`S`	`writeFloat(float f)`
`default void`	`writeHistogram(net.openhft.chronicle.core.util.Histogram histogram)`
`S`	`writeInt(int i)`
`default S`	`writeInt24(int i)`
`default long`	`writeLimit()`
`S`	`writeLimit(long limit)`
`S`	`writeLong(long i64)`
`S`	`writeOrderedInt(int i)`
`S`	`writeOrderedLong(long i)`
`default long`	`writePosition()` The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
`S`	`writePosition(long position)`
`default void`	`writePositionRemaining(long position, long length)`
`default long`	`writeRemaining()`
`S`	`writeShort(short i16)`
`S`	`writeSkip(long bytesToSkip)` Skip a number of bytes by moving the readPosition.
`S`	`writeSome(ByteBuffer buffer)`
`default S`	`writeSome(Bytes bytes)`
`default S`	`writeStopBit(double d)`
`default S`	`writeStopBit(long x)` Write a stop bit encoded long
`default S`	`writeUnsignedByte(int i)`
`default S`	`writeUnsignedInt(long i)`
`default S`	`writeUnsignedShort(int u16)`
`default S`	`writeUtf8(CharSequence cs)` Write the same encoding as `writeUTF` with the following changes.
`default S`	`writeUtf8(String s)`
`default S`	`writeUTFΔ(CharSequence cs)` Deprecated.

Methods inherited from interface net.openhft.chronicle.core.ReferenceCounted
refCount, release, release, releaseAll, reserve, tryReserve

Method Detail

writePosition

S writePosition(long position)
         throws BufferOverflowException

Throws:: BufferOverflowException

writeLimit

S writeLimit(long limit)
      throws BufferOverflowException

Throws:: BufferOverflowException

writeSkip
```
S writeSkip(long bytesToSkip)
     throws BufferOverflowException
```
Skip a number of bytes by moving the readPosition. Must be less than or equal to the readLimit.

Parameters:

bytesToSkip - bytes to skip.

Returns:

this

Throws:

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

outputStream

@NotNull
default OutputStream outputStream()

Returns:: Bytes as an OutputStream

writeStopBit
```
@NotNull
default S writeStopBit(long x)
                         throws BufferOverflowException
```
Write a stop bit encoded long

Parameters:

x - long to write

Returns:

this.

Throws:

BufferOverflowException

writeStopBit

default S writeStopBit(double d)
                throws BufferOverflowException

Throws:: BufferOverflowException

writeUtf8
```
@NotNull
default S writeUtf8(CharSequence cs)
                      throws BufferOverflowException
```
Write the same encoding as writeUTF with the following changes. 1) The length is stop bit encoded i.e. one byte longer for short strings, but is not limited in length. 2) The string can be null.

Parameters:

cs - the string value to be written. Can be null.

Throws:

BufferOverflowException - if there is not enough space left

writeUtf8

default S writeUtf8(String s)
             throws BufferOverflowException

Throws:: BufferOverflowException

writeUTFΔ

@Deprecated
default S writeUTFΔ(CharSequence cs)
                         throws BufferOverflowException

Deprecated.

Throws:: BufferOverflowException

write8bit

default S write8bit(CharSequence cs)
             throws BufferOverflowException

Throws:: BufferOverflowException

write8bit

default S write8bit(CharSequence s,
                    int start,
                    int length)
             throws BufferOverflowException,
                    IllegalArgumentException,
                    IndexOutOfBoundsException

Throws:: BufferOverflowException; IllegalArgumentException; IndexOutOfBoundsException

write

default S write(CharSequence cs)
         throws BufferOverflowException,
                BufferUnderflowException,
                IllegalArgumentException

Throws:: BufferOverflowException; BufferUnderflowException; IllegalArgumentException

write

default S write(CharSequence s,
                int start,
                int length)
         throws BufferOverflowException,
                IllegalArgumentException,
                IndexOutOfBoundsException

Throws:: BufferOverflowException; IllegalArgumentException; IndexOutOfBoundsException

write8bit

default S write8bit(@NotNull
                    String s)
             throws BufferOverflowException

Throws:: BufferOverflowException

write8bit

default S write8bit(@NotNull
                    BytesStore sdi)
             throws BufferOverflowException

Throws:: BufferOverflowException

writeByte

@NotNull
S writeByte(byte i8)
              throws BufferOverflowException

Throws:: BufferOverflowException

writeUnsignedByte

@NotNull
default S writeUnsignedByte(int i)
                              throws BufferOverflowException,
                                     IllegalArgumentException

Throws:: BufferOverflowException; IllegalArgumentException

writeShort

@NotNull
S writeShort(short i16)
               throws BufferOverflowException

Throws:: BufferOverflowException

writeUnsignedShort

@NotNull
default S writeUnsignedShort(int u16)
                               throws BufferOverflowException,
                                      IllegalArgumentException

Throws:: BufferOverflowException; IllegalArgumentException

writeInt24

@NotNull
default S writeInt24(int i)
                       throws BufferOverflowException

Throws:: BufferOverflowException

writeInt

@NotNull
S writeInt(int i)
             throws BufferOverflowException

Throws:: BufferOverflowException

writeUnsignedInt

@NotNull
default S writeUnsignedInt(long i)
                             throws BufferOverflowException,
                                    IllegalArgumentException

Throws:: BufferOverflowException; IllegalArgumentException

writeLong

@NotNull
S writeLong(long i64)
              throws BufferOverflowException

Throws:: BufferOverflowException

writeFloat

@NotNull
S writeFloat(float f)
               throws BufferOverflowException

Throws:: BufferOverflowException

writeDouble

@NotNull
S writeDouble(double d)
                throws BufferOverflowException

Throws:: BufferOverflowException

write

@NotNull
default S write(@NotNull
                         BytesStore bytes)
                  throws BufferOverflowException

Write all data or fail.

Throws:: BufferOverflowException

realCapacity
```
long realCapacity()
```

writeSome

@NotNull
default S writeSome(@NotNull
                             Bytes bytes)
                      throws BufferOverflowException

Throws:: BufferOverflowException

write

@NotNull
default S write(@NotNull
                         BytesStore bytes,
                         long offset,
                         long length)
                  throws BufferOverflowException,
                         BufferUnderflowException,
                         IllegalArgumentException

Write all data or fail.

Throws:: BufferOverflowException; BufferUnderflowException; IllegalArgumentException

write

@NotNull
default S write(@NotNull
                         byte[] bytes)
                  throws BufferOverflowException

Throws:: BufferOverflowException

write

@NotNull
S write(byte[] bytes,
                 int offset,
                 int length)
          throws BufferOverflowException,
                 IllegalArgumentException

Write all data or fail.

Throws:: BufferOverflowException; IllegalArgumentException

writeSome

@NotNull
S writeSome(ByteBuffer buffer)
              throws BufferOverflowException

Throws:: BufferOverflowException

writeBoolean

@NotNull
default S writeBoolean(boolean flag)
                         throws BufferOverflowException

Throws:: BufferOverflowException

writeOrderedInt

@NotNull
S writeOrderedInt(int i)
                    throws BufferOverflowException

Throws:: BufferOverflowException

writeOrderedLong

@NotNull
S writeOrderedLong(long i)
                     throws BufferOverflowException

Throws:: BufferOverflowException

nativeWrite
```
void nativeWrite(long address,
                 long size)
          throws BufferOverflowException
```
This is an expert level method for writing out data to native memory.

Parameters:

address - to write to.

size - in bytes.

Throws:

BufferOverflowException

writeEnum

default <E extends Enum<E>> void writeEnum(E e)
                                    throws BufferOverflowException

Throws:: BufferOverflowException

appendUtf8

default S appendUtf8(CharSequence cs)
              throws BufferOverflowException

Throws:: BufferOverflowException

appendUtf8

default S appendUtf8(int codepoint)
              throws BufferOverflowException

Throws:: BufferOverflowException

appendUtf8

default S appendUtf8(char[] chars,
                     int offset,
                     int length)
              throws BufferOverflowException,
                     IllegalArgumentException

Throws:: BufferOverflowException; IllegalArgumentException

appendUtf8

default S appendUtf8(CharSequence cs,
                     int offset,
                     int length)
              throws BufferOverflowException,
                     IllegalArgumentException

Throws:: BufferOverflowException; IllegalArgumentException

copyFrom

default void copyFrom(InputStream input)
               throws IOException,
                      BufferOverflowException,
                      IllegalArgumentException

Throws:: IOException; BufferOverflowException; IllegalArgumentException

writePositionRemaining

default void writePositionRemaining(long position,
                                    long length)

writeHistogram

default void writeHistogram(net.openhft.chronicle.core.util.Histogram histogram)

writeBigDecimal

default void writeBigDecimal(BigDecimal bd)

writeBigInteger

default void writeBigInteger(BigInteger bi)

clear
```
@NotNull
S clear()
```
Set the readPosition= writePosition = start, writeLimit = capacity

Returns:

this

start
```
default long start()
```
Returns:

The smallest position allowed in this buffer.

capacity
```
default long capacity()
```
Returns:

the highest limit allowed for this buffer.

readPosition
```
default long readPosition()
```
The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()

Returns:

position to read from.

writePosition
```
default long writePosition()
```
The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()

Returns:

position to write to.

readRemaining
```
default long readRemaining()
```
Returns:

How many more bytes can we read.

writeRemaining
```
default long writeRemaining()
```
Returns:

How many more bytes can we written.

readLimit
```
default long readLimit()
```
Returns:

the highest offset or position allowed for this buffer.

writeLimit
```
default long writeLimit()
```

address
```
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
```
default ByteOrder byteOrder()
```

bytesForRead
```
Bytes bytesForRead()
            throws IllegalStateException
```
Returns:

the streaming bytes for reading.

Throws:

IllegalStateException

bytesForWrite
```
Bytes bytesForWrite()
             throws IllegalStateException
```
Returns:

the streaming bytes for writing.

Throws:

IllegalStateException

compareAndSwapInt

boolean compareAndSwapInt(long offset,
                          int expected,
                          int value)
                   throws BufferOverflowException,
                          IllegalArgumentException

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

compareAndSwapLong

boolean compareAndSwapLong(long offset,
                           long expected,
                           long value)
                    throws BufferOverflowException,
                           IllegalArgumentException

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

compareAndSwapFloat

default boolean compareAndSwapFloat(long offset,
                                    float expected,
                                    float value)
                             throws BufferOverflowException,
                                    IllegalArgumentException

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

compareAndSwapDouble

default boolean compareAndSwapDouble(long offset,
                                     double expected,
                                     double value)
                              throws BufferOverflowException,
                                     IllegalArgumentException

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

sharedMemory
```
boolean sharedMemory()
```
Returns:

true if these Bytes use shared memory.

isDirectMemory
```
boolean isDirectMemory()
```

Interface StreamingDataOutput<S extends StreamingDataOutput<S>>

Method Summary

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

Method Detail

writePosition

writeLimit

writeSkip

outputStream

writeStopBit

writeStopBit

writeUtf8

writeUtf8

writeUTFΔ

write8bit

write8bit

write

write

write8bit

write8bit

writeByte

writeUnsignedByte

writeShort

writeUnsignedShort

writeInt24

writeInt

writeUnsignedInt

writeLong

writeFloat

writeDouble

write

realCapacity

writeSome

write

write

write

writeSome

writeBoolean

writeOrderedInt

writeOrderedLong

nativeWrite

writeEnum

appendUtf8

appendUtf8

appendUtf8

appendUtf8

copyFrom

writePositionRemaining

writeHistogram

writeBigDecimal

writeBigInteger

clear

start

capacity

readPosition

writePosition

readRemaining

writeRemaining

readLimit

writeLimit

address

byteOrder

bytesForRead

bytesForWrite

compareAndSwapInt

compareAndSwapLong

compareAndSwapFloat

compareAndSwapDouble

sharedMemory

isDirectMemory