Package dev.getelements.elements.rt.transact.unix

Class UnixFSCircularBlockBuffer

java.lang.Object

dev.getelements.elements.rt.transact.unix.UnixFSCircularBlockBuffer

public class UnixFSCircularBlockBuffer
extends Object

Given a ByteBuffer, this slices the buffer into a series of smaller ByteBuffers which represent a subset of the data. This allows a ByteBuffer to be used by several threads w/ exclusive access to subsections of the content. While this structure's behavior is thread safe, care must be taken by the client code to ensure that the data contained in the block buffer is mutated appropriately. Specifically each UnixFSCircularBlockBuffer.Slice instance returend by this UnixFSCircularBlockBuffer is not thread safe. Therefore, additional steps must be taken to ensure predictable behavior when dealing with the individual UnixFSCircularBlockBuffer.Slices of this buffer. The UnixFSCircularBlockBuffer.View.stream() UnixFSCircularBlockBuffer.View.reverse() methods of this class uses a snapshot of the trailing/leading values and it is possible that data has changed while iterating. Therefore, code using an iterator must be prepared to handle such scenarios.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	UnixFSCircularBlockBuffer.Slice<T>	Represents a slice of the provided byte buffer array.
static interface	UnixFSCircularBlockBuffer.View<ViewedT>	Represents a view of the underlying UnixFSCircularBlockBuffer.

Constructor Summary

Constructors

Constructor	Description
UnixFSCircularBlockBuffer(UnixFSAtomicLong atomicLong, ByteBuffer buffer, int blockSize)

Method Summary

Modifier and Type	Method	Description
<StructT extends javolution.io.Struct> UnixFSCircularBlockBuffer.View<StructT>	forStructType(Supplier<StructT> structSuppler)	Allows for the creation of a UnixFSCircularBlockBuffer.View<StructT extends javolution.io.Struct> which can represent the underlying data slices as a fixed-sized array of Struct types.
UnixFSCircularBlockBuffer.View<ByteBuffer>	rawView()	Returns a raw-view of the circular block buffer.
UnixFSCircularBlockBuffer	reset()	Resets the UnixFSCircularBlockBuffer
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

UnixFSCircularBlockBuffer

public UnixFSCircularBlockBuffer(UnixFSAtomicLong atomicLong,
 ByteBuffer buffer,
 int blockSize)

Method Details

reset

public UnixFSCircularBlockBuffer reset()

Resets the UnixFSCircularBlockBuffer

Returns:

this instance

rawView

public UnixFSCircularBlockBuffer.View<ByteBuffer> rawView()

Returns a raw-view of the circular block buffer.

Returns:

the raw view

forStructType

public <StructT extends javolution.io.Struct>
UnixFSCircularBlockBuffer.View<StructT> forStructType(Supplier<StructT> structSuppler)

Allows for the creation of a UnixFSCircularBlockBuffer.View<StructT extends javolution.io.Struct> which can represent the underlying data slices as a fixed-sized array of Struct types.

Type Parameters:

StructT - the type of the struct

Parameters:

structSuppler - the UnixFSCircularBlockBuffer supplier

Returns:

the new typed view

toString

public String toString()

Overrides:

toString in class Object