io.aeron

Class DirectBufferVector

java.lang.Object

io.aeron.DirectBufferVector

public final class DirectBufferVector
extends java.lang.Object

Vector into a DirectBuffer to be used for gathering IO as and offset and length.

Field Summary

Fields

Modifier and Type	Field and Description
org.agrona.DirectBuffer	buffer
int	length
int	offset

Constructor Summary

Constructors

Constructor and Description
DirectBufferVector() Default constructor so the fluent API can be used.
DirectBufferVector(org.agrona.DirectBuffer buffer, int offset, int length) Construct a new vector as a subset of a buffer.

Method Summary

Modifier and Type	Method and Description
org.agrona.DirectBuffer	buffer() The buffer which the vector applies to.
DirectBufferVector	buffer(org.agrona.DirectBuffer buffer) The buffer which the vector applies to.
int	length() Length of the vector in the buffer starting at the offset.
DirectBufferVector	length(int length) Length of the vector in the buffer starting at the offset.
int	offset() Offset in the buffer at which the vector starts.
DirectBufferVector	offset(int offset) Offset in the buffer at which the vector starts.
DirectBufferVector	reset(org.agrona.DirectBuffer buffer, int offset, int length) Reset the values.
java.lang.String	toString()
DirectBufferVector	validate() Ensure the vector is valid for the buffer.
static int	validateAndComputeLength(DirectBufferVector[] vectors) Validate an array of vectors to make up a message and compute the total length.

Methods inherited from class java.lang.Object

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

Field Detail

buffer

public org.agrona.DirectBuffer buffer

offset

public int offset

length

public int length

Constructor Detail

DirectBufferVector

public DirectBufferVector()

Default constructor so the fluent API can be used.

DirectBufferVector

public DirectBufferVector(org.agrona.DirectBuffer buffer,
                          int offset,
                          int length)

Construct a new vector as a subset of a buffer.

Parameters:

buffer - which is the super set.

offset - at which the vector begins.

length - of the vector.

Method Detail

reset

public DirectBufferVector reset(org.agrona.DirectBuffer buffer,
                                int offset,
                                int length)

Reset the values.

Parameters:

buffer - which is the super set.

offset - at which the vector begins.

length - of the vector.

Returns:

this for a fluent API.

buffer

public org.agrona.DirectBuffer buffer()

The buffer which the vector applies to.

Returns:

buffer which the vector applies to.

buffer

public DirectBufferVector buffer(org.agrona.DirectBuffer buffer)

The buffer which the vector applies to.

Parameters:

buffer - which the vector applies to.

Returns:

this for a fluent API.

offset

public int offset()

Offset in the buffer at which the vector starts.

Returns:

offset in the buffer at which the vector starts.

offset

public DirectBufferVector offset(int offset)

Offset in the buffer at which the vector starts.

Parameters:

offset - in the buffer at which the vector starts.

Returns:

this for a fluent API.

length

public int length()

Length of the vector in the buffer starting at the offset.

Returns:

length of the vector in the buffer starting at the offset.

length

public DirectBufferVector length(int length)

Length of the vector in the buffer starting at the offset.

Parameters:

length - of the vector in the buffer starting at the offset.

Returns:

this for a fluent API.

validate

public DirectBufferVector validate()

Ensure the vector is valid for the buffer.

Returns:

this for a fluent API.

Throws:

java.lang.NullPointerException - if the buffer is null.

java.lang.IllegalArgumentException - if the offset is out of range for the buffer.

java.lang.IllegalArgumentException - if the length is out of range for the buffer.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validateAndComputeLength

public static int validateAndComputeLength(DirectBufferVector[] vectors)

Validate an array of vectors to make up a message and compute the total length.

Parameters:

vectors - to be validated summed.

Returns:

the sum of the vector lengths.