io.netty.channel.unix

Class IovArray

java.lang.Object

io.netty.channel.unix.IovArray

All Implemented Interfaces:

ChannelOutboundBuffer.MessageProcessor

public final class IovArray
extends 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()

Method Summary

Modifier and Type	Method and Description
boolean	add(ByteBuf buf) Try to add the given ByteBuf.
boolean	add(CompositeByteBuf buf) Try to add the given CompositeByteBuf.
void	clear()
int	count() Returns the number if iov entries.
long	memoryAddress(int offset) Returns the memoryAddress for the given offset.
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.
long	processWritten(int index, long written) Process the written iov entries.
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)

Try to add the given ByteBuf. Returns true on success, false otherwise.

add

public boolean add(CompositeByteBuf buf)

Try to add the given CompositeByteBuf. Returns true on success, false otherwise.

processWritten

public long processWritten(int index,
                           long written)

Process the written iov entries. This will return the length of the iov entry on the given index if it is smaller then the given written value. Otherwise it returns -1.

count

public int count()

Returns the number if iov entries.

size

public long size()

Returns the size in bytes

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(Object msg)
                       throws 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:

Exception