Module io.netty5.transport.unix.common

Package io.netty5.channel.unix

Class IovArray

java.lang.Object

io.netty5.channel.unix.IovArray

All Implemented Interfaces:

Predicate<Object>

public final class IovArray
extends Object
implements Predicate<Object>

Represent an array of struct array and so can be passed directly over via JNI without the need to do any more array copies.

The buffers are written out directly into direct memory to match the struct iov. See also man writev.

 struct iovec {
   void  *iov_base;
   size_t iov_len;
 };
 

See also Efficient JNI programming IV: Wrapping native data objects.

Field Summary

Fields

Modifier and Type	Field	Description
static int	IOV_SIZE	The size of an iovec struct in bytes.

Constructor Summary

Constructors

Constructor	Description
IovArray()
IovArray(ByteBuffer memory)

Method Summary

Modifier and Type	Method	Description
boolean	addReadable(io.netty5.buffer.Buffer buffer)
boolean	addReadable(io.netty5.buffer.BufferComponent component, int byteCount)
boolean	addWritable(io.netty5.buffer.Buffer buffer)
boolean	addWritable(io.netty5.buffer.BufferComponent component, int byteCount)
void	clear()
int	count()	Returns the number if iov entries.
long	maxBytes()	Get the maximum amount of bytes that can be added to this IovArray.
void	maxBytes(long maxBytes)	Set the maximum amount of bytes that can be added to this IovArray via add(long, long, int) or test(Object).
long	memoryAddress(int index)	Returns the memoryAddress for the given index.
void	release()	Release the IovArray.
long	size()	Returns the size in bytes
boolean	test(Object msg)
int	writtenMessages(int index, long totalBytes)	Return the number of messages that have been completely written for the given total number of bytes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, negate, or

Field Detail

IOV_SIZE

public static final int IOV_SIZE

The size of an iovec struct in bytes. This is calculated as we have 2 entries each of the size of the address.

Constructor Detail

IovArray

public IovArray()

IovArray

public IovArray(ByteBuffer memory)

Method Detail

clear

public void clear()

writtenMessages

public int writtenMessages(int index,
                           long totalBytes)

Return the number of messages that have been completely written for the given total number of bytes.

Parameters:

index - the start index.

totalBytes - the total number of bytes

Returns:

the number of messages that are totally written for the given number of total bytes.

count

public int count()

Returns the number if iov entries.

size

public long size()

Returns the size in bytes

maxBytes

public void maxBytes(long maxBytes)

Set the maximum amount of bytes that can be added to this IovArray via add(long, long, int) or test(Object).

This will not impact the existing state of the IovArray, and only applies to subsequent calls to add(long, long, int) or test(Object).

In order to ensure some progress is made at least one Buffer will be accepted even if it's size exceeds this value.

Parameters:

maxBytes - the maximum amount of bytes that can be added to this IovArray.

maxBytes

public long maxBytes()

Get the maximum amount of bytes that can be added to this IovArray.

Returns:

the maximum amount of bytes that can be added to this IovArray.

memoryAddress

public long memoryAddress(int index)

Returns the memoryAddress for the given index.

release

public void release()

Release the IovArray. Once release further using of it may crash the JVM!

test

public boolean test(Object msg)

Specified by:

test in interface Predicate<Object>

addReadable

public boolean addReadable(io.netty5.buffer.Buffer buffer)

addReadable

public boolean addReadable(io.netty5.buffer.BufferComponent component,
                           int byteCount)

addWritable

public boolean addWritable(io.netty5.buffer.Buffer buffer)

addWritable

public boolean addWritable(io.netty5.buffer.BufferComponent component,
                           int byteCount)