java.lang.Object
- io.netty5.channel.unix.IovArray

All Implemented Interfaces:

ReadableComponentProcessor<RuntimeException>, WritableComponentProcessor<RuntimeException>, ChannelOutboundBuffer.MessageProcessor
```
public final class IovArray
extends Object
implements ChannelOutboundBuffer.MessageProcessor, ReadableComponentProcessor<RuntimeException>, WritableComponentProcessor<RuntimeException>
```
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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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 `processMessage(Object)`.
`long`	`memoryAddress(int index)`	Returns the `memoryAddress` for the given `index`.
`boolean`	`process(int index, ReadableComponent component)`	Process the given component at the given index in the `iteration`.
`boolean`	`process(int index, WritableComponent component)`	Process the given component at the given index in the `Buffer.forEachWritable(int, WritableComponentProcessor)` iteration}.
`boolean`	`process(ReadableComponent component, int byteCount)`
`boolean`	`process(WritableComponent component, int byteCount)`
`boolean`	`processMessage(Object msg)`	Will be called for each flushed message until it either there are no more flushed messages or this method returns `false`.
`void`	`release()`	Release the `IovArray`.
`long`	`size()`	Returns the size in bytes

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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()
```
  - 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 processMessage(Object).
    This will not impact the existing state of the IovArray, and only applies to subsequent calls to add(long, long, int) or processMessage(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!
  - processMessage
```
public boolean processMessage(Object msg)
```
    Description copied from interface: ChannelOutboundBuffer.MessageProcessor
    
    Will be called for each flushed message until it either there are no more flushed messages or this method returns false.
    
    Specified by:
    
    processMessage in interface ChannelOutboundBuffer.MessageProcessor
  - process
```
public boolean process(int index,
                       ReadableComponent component)
```
    Description copied from interface: ReadableComponentProcessor
    
    Process the given component at the given index in the iteration.
    The component object itself is only valid during this call, but the byte buffers, arrays, and native address pointers obtained from it, will be valid until any operation is performed on the buffer, which changes the internal memory.
    
    Specified by:
    
    process in interface ReadableComponentProcessor<RuntimeException>
    
    Parameters:
    
    index - The current index of the given buffer component, based on the initial index passed to the Buffer.forEachReadable(int, ReadableComponentProcessor) method.
    
    component - The current buffer component being processed.
    
    Returns:
    
    true if the iteration should continue and more components should be processed, otherwise false to stop the iteration early.
  - process
```
public boolean process(ReadableComponent component,
                       int byteCount)
```
  - process
```
public boolean process(int index,
                       WritableComponent component)
```
    Description copied from interface: WritableComponentProcessor
    
    Process the given component at the given index in the Buffer.forEachWritable(int, WritableComponentProcessor) iteration}.
    The component object itself is only valid during this call, but the byte buffers, arrays, and native address pointers obtained from it, will be valid until any ownership requiring operation is performed on the buffer.
    
    Specified by:
    
    process in interface WritableComponentProcessor<RuntimeException>
    
    Parameters:
    
    index - The current index of the given buffer component, based on the initial index passed to the Buffer.forEachWritable(int, WritableComponentProcessor) method.
    
    component - The current buffer component being processed.
    
    Returns:
    
    true if the iteration should continue and more components should be processed, otherwise false to stop the iteration early.
  - process
```
public boolean process(WritableComponent component,
                       int byteCount)
```

Constructors
Constructor	Description
`IovArray()`
`IovArray(ByteBuffer memory)`

Class IovArray

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IOV_SIZE

Constructor Detail

IovArray

IovArray

Method Detail

clear

count

size

maxBytes

maxBytes

memoryAddress

release

processMessage

process

process

process

process