net.openhft.chronicle.bytes

Interface StreamingCommon<S extends StreamingCommon<S>>

Type Parameters:

S - type of the implementing class

All Superinterfaces:

RandomCommon, net.openhft.chronicle.core.io.ReferenceCounted, net.openhft.chronicle.core.io.ReferenceOwner

All Known Subinterfaces:

Bytes<U>, BytesIn<U>, BytesOut<U>, ByteStringAppender<B>, ByteStringParser<B>, StreamingDataInput<S>, StreamingDataOutput<S>

All Known Implementing Classes:

AbstractBytes, GuardedNativeBytes, HexDumpBytes, MappedBytes, NativeBytes, OnHeapBytes, SubBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes

public interface StreamingCommon<S extends StreamingCommon<S>>
extends RandomCommon

A common base interface for streaming data access. It manages fundamental buffer properties such as positions and limits and supports random access semantics. Implementations are mainly used by higher level streaming interfaces like StreamingDataInput and StreamingDataOutput.

Field Summary

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

INIT, TMP

Method Summary

Modifier and Type	Method and Description
S	clear() Resets the read and write positions to RandomCommon.start() and sets the effective limits to RandomCommon.capacity().

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

addressForRead, addressForRead, addressForWrite, addressForWritePosition, byteOrder, bytesForRead, bytesForWrite, capacity, isDirectMemory, lengthWritten, readLimit, readPosition, readRemaining, realCapacity, realReadRemaining, realWriteRemaining, sharedMemory, start, writeLimit, writePosition, writeRemaining

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

addReferenceChangeListener, refCount, release, releaseLast, releaseLast, removeReferenceChangeListener, reserve, reserveTransfer, tryReserve

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

referenceId, referenceName, temporary

Method Detail

clear

@NotNull
S clear()
          throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                 net.openhft.chronicle.core.io.ThreadingIllegalStateException

Resets the read and write positions to RandomCommon.start() and sets the effective limits to RandomCommon.capacity(). The underlying data is left unchanged but the buffer behaves as if newly allocated.

Returns:

this instance for chaining

Throws:

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

net.openhft.chronicle.core.io.ThreadingIllegalStateException - if accessed by multiple threads in an unsafe way