IovArray (Netty API Reference (4.1.28.Final))

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

All Implemented Interfaces:

ChannelOutboundBuffer.MessageProcessor
```
public final class IovArray
extends java.lang.Object
implements ChannelOutboundBuffer.MessageProcessor
```
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.

Constructor Summary

Constructors
Constructor and Description

IovArray()

Constructors
Constructor and Description
`IovArray()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(ByteBuf buf)` Add a `ByteBuf` to this `IovArray`.
`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` via `add(ByteBuf)`.
`void`	`maxBytes(long maxBytes)` Set the maximum amount of bytes that can be added to this `IovArray` via `add(ByteBuf)`.
`long`	`memoryAddress(int offset)` Returns the `memoryAddress` for the given `offset`.
`boolean`	`processMessage(java.lang.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

- Constructor Detail
  - IovArray
```
public IovArray()
```
- Method Detail
  - clear
```
public void clear()
```
  - add
```
public boolean add(ByteBuf buf)
```
    Add a ByteBuf to this IovArray.
    
    Parameters:
    
    buf - The ByteBuf to add.
    
    Returns:
    
    true if the entire ByteBuf has been added to this IovArray. Note in the event that ByteBuf is a CompositeByteBuf false may be returned even if some of the components have been added.
  - 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(ByteBuf).
    This will not impact the existing state of the IovArray, and only applies to subsequent calls to add(ByteBuf).
    In order to ensure some progress is made at least one ByteBuf 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 via add(ByteBuf).
  - maxBytes
```
public long maxBytes()
```
    Get the maximum amount of bytes that can be added to this IovArray via add(ByteBuf).
    
    Returns:
    
    the maximum amount of bytes that can be added to this IovArray via add(ByteBuf).
  - memoryAddress
```
public long memoryAddress(int offset)
```
    Returns the memoryAddress for the given offset.
  - release
```
public void release()
```
    Release the IovArray. Once release further using of it may crash the JVM!
  - processMessage
```
public boolean processMessage(java.lang.Object msg)
                       throws java.lang.Exception
```
    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
    
    Throws:
    
    java.lang.Exception

Class IovArray

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IovArray

Method Detail

clear

add

count

size

maxBytes

maxBytes

memoryAddress

release

processMessage