StreamingDataOutput (OpenHFT/Chronicle-Bytes 1.0.17-beta API)

All Known Subinterfaces:

Bytes<Underlying>, ByteStringAppender<B>

All Known Implementing Classes:

AbstractBytes, MappedBytes, NativeBytes, UncheckedBytes, 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
Modifier and Type	Method and Description
`long`	`address(long offset)` Obtain the underlying address.
`default ByteOrder`	`byteOrder()`
`Bytes`	`bytesForRead()`
`Bytes`	`bytesForWrite()`
`default long`	`capacity()`
`S`	`clear()`
`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()`
`default long`	`readRemaining()`
`S`	`readSkip(long bytesToSkip)`
`default long`	`start()`
`default S`	`write(byte[] bytes)`
`S`	`write(byte[] bytes, int offset, int length)`
`S`	`write(ByteBuffer buffer)`
`default S`	`write(BytesStore bytes)`
`default S`	`write(BytesStore bytes, long offset, long length)`
`default S`	`writeBoolean(boolean flag)`
`S`	`writeByte(byte i8)`
`S`	`writeDouble(double d)`
`S`	`writeFloat(float f)`
`S`	`writeInt(int i)`
`default long`	`writeLimit()`
`S`	`writeLimit(long limit)`
`S`	`writeLong(long i64)`
`S`	`writeOrderedInt(int i)`
`S`	`writeOrderedLong(long i)`
`default long`	`writePosition()`
`S`	`writePosition(long position)`
`default long`	`writeRemaining()`
`S`	`writeShort(short i16)`
`S`	`writeSkip(long bytesToSkip)`
`default S`	`writeStopBit(long x)`
`default S`	`writeUnsignedByte(int i)`
`default S`	`writeUnsignedInt(long i)`
`default S`	`writeUnsignedShort(int u16)`
`default S`	`writeUTFΔ(CharSequence cs)` Write the same encoding as `writeUTF` with the following changes.

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

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

Method Detail

outputStream
```
default OutputStream outputStream()
```

writeStopBit
```
default S writeStopBit(long x)
```

writePosition
```
S writePosition(long position)
```

writeLimit
```
S writeLimit(long limit)
```

writeUTFΔ
```
default S writeUTFΔ(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

writeByte
```
S writeByte(byte i8)
```

writeUnsignedByte
```
default S writeUnsignedByte(int i)
```

writeShort
```
S writeShort(short i16)
```

writeUnsignedShort

default S writeUnsignedShort(int u16)

writeInt
```
S writeInt(int i)
```

writeUnsignedInt
```
default S writeUnsignedInt(long i)
```

writeLong
```
S writeLong(long i64)
```

writeFloat
```
S writeFloat(float f)
```

writeDouble
```
S writeDouble(double d)
```

write
```
default S write(BytesStore bytes)
```

write

default S write(BytesStore bytes,
                long offset,
                long length)

write
```
default S write(byte[] bytes)
```

write

S write(byte[] bytes,
        int offset,
        int length)

write
```
S write(ByteBuffer buffer)
```

writeBoolean
```
default S writeBoolean(boolean flag)
```

writeOrderedInt
```
S writeOrderedInt(int i)
```

writeOrderedLong
```
S writeOrderedLong(long i)
```

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

Parameters:

address - to write to.

size - in bytes.

clear
```
S clear()
```

readSkip
```
S readSkip(long bytesToSkip)
```

writeSkip
```
S writeSkip(long bytesToSkip)
```

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()
```

writePosition
```
default long writePosition()
```

readRemaining
```
default long readRemaining()
```

writeRemaining
```
default long writeRemaining()
```

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
```
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

byteOrder
```
default ByteOrder byteOrder()
```

bytesForRead
```
Bytes bytesForRead()
```
Returns:

the streaming bytes for reading.

bytesForWrite
```
Bytes bytesForWrite()
```
Returns:

the streaming bytes for writing.

Interface StreamingDataOutput<S extends StreamingDataOutput<S>>

Method Summary

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

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

Method Detail

outputStream

writeStopBit

writePosition

writeLimit

writeUTFΔ

writeByte

writeUnsignedByte

writeShort

writeUnsignedShort

writeInt

writeUnsignedInt

writeLong

writeFloat

writeDouble

write

write

write

write

write

writeBoolean

writeOrderedInt

writeOrderedLong

nativeWrite

clear

readSkip

writeSkip

start

capacity

readPosition

writePosition

readRemaining

writeRemaining

readLimit

writeLimit

address

byteOrder

bytesForRead

bytesForWrite