Top Description Inners Fields Constructors Methods
org.lwjgl.system.linux

public Class IOVec

extends Struct<IOVec>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct iovec
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


struct iovec {
    void * iov_base;
    size_t iov_len;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
IOVec.Buffer

An array of IOVec structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
IOV_BASE

The struct member offsets.

public static final int
IOV_LEN

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
IOVec(long address, ByteBuffer container)

public
IOVec(ByteBuffer container)

Creates a IOVec instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static IOVec
calloc()

Returns a new IOVec instance allocated with memCalloc.

public static IOVec.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new IOVec.Buffer instance allocated with memCalloc.

public static IOVec
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new IOVec instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static IOVec.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new IOVec.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected IOVec
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static IOVec
create()

Returns a new IOVec instance allocated with BufferUtils.

public static IOVec
create(long address)

Returns a new IOVec instance for the specified memory address.

public static IOVec.Buffer
create(int
the buffer capacity
capacity
)

Returns a new IOVec.Buffer instance allocated with BufferUtils.

public static IOVec.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a IOVec.Buffer instance at the specified memory.

public static IOVec
createSafe(long address)

Like create, but returns null if address is NULL.

public static IOVec.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public ByteBuffer
iov_base()

starting address

public IOVec
iov_base(ByteBuffer value)

Sets the address of the specified ByteBuffer to the iov_base field.

public long
iov_len()

number of bytes to transfer

public IOVec
iov_len(long value)

Sets the specified value to the iov_len field.

public static IOVec
malloc()

Returns a new IOVec instance allocated with memAlloc.

public static IOVec.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new IOVec.Buffer instance allocated with memAlloc.

public static IOVec
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new IOVec instance allocated on the specified MemoryStack.

public static IOVec.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new IOVec.Buffer instance allocated on the specified MemoryStack.

public static ByteBuffer
niov_base(long struct)

Unsafe version of iov_base.

public static void
niov_base(long struct, ByteBuffer value)

Unsafe version of iov_base.

public static long
niov_len(long struct)

Unsafe version of iov_len.

public static void
niov_len(long struct, long value)

Unsafe version of iov_len.

public IOVec
set(ByteBuffer iov_base, long iov_len)

Initializes this struct with the specified values.

public IOVec

Returns:

this struct
set
(IOVec
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

IOV_BASEback to summary
public static final int IOV_BASE

The struct member offsets.

IOV_LENback to summary
public static final int IOV_LEN

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

IOVecback to summary
protected IOVec(long address, ByteBuffer container)
IOVecback to summary
public IOVec(ByteBuffer container)

Creates a IOVec instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Detail

callocback to summary
public static IOVec calloc()

Returns a new IOVec instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static IOVec.Buffer calloc(int capacity)

Returns a new IOVec.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static IOVec calloc(MemoryStack stack)

Returns a new IOVec instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static IOVec.Buffer calloc(int capacity, MemoryStack stack)

Returns a new IOVec.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected IOVec create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static IOVec create()

Returns a new IOVec instance allocated with BufferUtils.

createback to summary
public static IOVec create(long address)

Returns a new IOVec instance for the specified memory address.

createback to summary
public static IOVec.Buffer create(int capacity)

Returns a new IOVec.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static IOVec.Buffer create(long address, int capacity)

Create a IOVec.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static IOVec createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static IOVec.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
iov_baseback to summary
public ByteBuffer iov_base()

starting address

Annotations
@Nullable
@NativeType:void *
iov_baseback to summary
public IOVec iov_base(ByteBuffer value)

Sets the address of the specified ByteBuffer to the iov_base field.

iov_lenback to summary
public long iov_len()

number of bytes to transfer

Annotations
@NativeType:size_t
iov_lenback to summary
public IOVec iov_len(long value)

Sets the specified value to the iov_len field.

mallocback to summary
public static IOVec malloc()

Returns a new IOVec instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static IOVec.Buffer malloc(int capacity)

Returns a new IOVec.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static IOVec malloc(MemoryStack stack)

Returns a new IOVec instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static IOVec.Buffer malloc(int capacity, MemoryStack stack)

Returns a new IOVec.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

niov_baseback to summary
public static ByteBuffer niov_base(long struct)

Unsafe version of iov_base.

Annotations
@Nullable
niov_baseback to summary
public static void niov_base(long struct, ByteBuffer value)

Unsafe version of iov_base.

niov_lenback to summary
public static long niov_len(long struct)

Unsafe version of iov_len.

niov_lenback to summary
public static void niov_len(long struct, long value)

Unsafe version of iov_len.

setback to summary
public IOVec set(ByteBuffer iov_base, long iov_len)

Initializes this struct with the specified values.

setback to summary
public IOVec set(IOVec src)

Copies the specified struct data to this struct.

Parameters
src:IOVec

the source struct

Returns:IOVec

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.system.linux back to summary

public Class IOVec.Buffer

extends StructBuffer<IOVec, IOVec.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of IOVec structs.

Field Summary

Modifier and TypeField and Description
private static final IOVec

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new IOVec.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected IOVec
public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the IOVec#iov_base field.
iov_base
()

public IOVec.Buffer
iov_base(ByteBuffer value)

Sets the address of the specified ByteBuffer to the IOVec#iov_base field.

public long

Returns:

the value of the IOVec#iov_len field.
iov_len
()

public IOVec.Buffer
iov_len(long value)

Sets the specified value to the IOVec#iov_len field.

protected IOVec.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final IOVec ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new IOVec.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by IOVec#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected IOVec getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
iov_baseback to summary
public ByteBuffer iov_base()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the IOVec#iov_base field.

Annotations
@Nullable
@NativeType:void *
iov_baseback to summary
public IOVec.Buffer iov_base(ByteBuffer value)

Sets the address of the specified ByteBuffer to the IOVec#iov_base field.

iov_lenback to summary
public long iov_len()
Returns:long

the value of the IOVec#iov_len field.

Annotations
@NativeType:size_t
iov_lenback to summary
public IOVec.Buffer iov_len(long value)

Sets the specified value to the IOVec#iov_len field.

selfback to summary
protected IOVec.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override