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

public Class IOURing

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

Layout


struct io_uring {
    struct io_uring_sq sq;
    struct io_uring_cq cq;
    unsigned int flags;
    int ring_fd;
    unsigned int features;
    int enter_ring_fd;
    __u8 int_flags;
    __u8 pad[3];
    unsigned pad2;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
IOURing.Buffer

An array of IOURing structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CQ

The struct member offsets.

public static final int
ENTER_RING_FD

The struct member offsets.

public static final int
FEATURES

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
INT_FLAGS

The struct member offsets.

public static final int
PAD

The struct member offsets.

public static final int
PAD2

The struct member offsets.

public static final int
RING_FD

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SQ

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
IOURing(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static IOURing
calloc()

Returns a new IOURing instance allocated with memCalloc.

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

Returns a new IOURing.Buffer instance allocated with memCalloc.

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

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

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

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

public IOURingCQ

Returns:

a IOURingCQ view of the cq field.
cq
()

public IOURing
cq(IOURingCQ value)

Copies the specified IOURingCQ to the cq field.

public IOURing
cq(Consumer<IOURingCQ> consumer)

Passes the cq field to the specified Consumer.

protected IOURing
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 IOURing
create()

Returns a new IOURing instance allocated with BufferUtils.

public static IOURing
create(long address)

Returns a new IOURing instance for the specified memory address.

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

Returns a new IOURing.Buffer instance allocated with BufferUtils.

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

Create a IOURing.Buffer instance at the specified memory.

public static IOURing
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int

Returns:

the value of the enter_ring_fd field.
enter_ring_fd
()

public IOURing
enter_ring_fd(int value)

Sets the specified value to the enter_ring_fd field.

public int

Returns:

the value of the features field.
features
()

public IOURing
features(int value)

Sets the specified value to the features field.

public int

Returns:

the value of the flags field.
flags
()

public IOURing
flags(int value)

Sets the specified value to the flags field.

public byte

Returns:

the value of the int_flags field.
int_flags
()

public IOURing
int_flags(byte value)

Sets the specified value to the int_flags field.

public static IOURing
malloc()

Returns a new IOURing instance allocated with memAlloc.

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

Returns a new IOURing.Buffer instance allocated with memAlloc.

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

Returns a new IOURing instance allocated on the specified MemoryStack.

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

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

public static IOURingCQ
ncq(long struct)

Unsafe version of cq.

public static void
ncq(long struct, IOURingCQ value)

Unsafe version of cq.

public static int
nenter_ring_fd(long struct)

Unsafe version of enter_ring_fd.

public static void
nenter_ring_fd(long struct, int value)

Unsafe version of enter_ring_fd.

public static int
nfeatures(long struct)

Unsafe version of features.

public static void
nfeatures(long struct, int value)

Unsafe version of features.

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static byte
nint_flags(long struct)

Unsafe version of int_flags.

public static void
nint_flags(long struct, byte value)

Unsafe version of int_flags.

public static ByteBuffer
npad(long struct)

public static byte
npad(long struct, int index)

public static void
npad(long struct, ByteBuffer value)

public static void
npad(long struct, int index, byte value)

public static int
npad2(long struct)

public static void
npad2(long struct, int value)

public static int
nring_fd(long struct)

Unsafe version of ring_fd.

public static void
nring_fd(long struct, int value)

Unsafe version of ring_fd.

public static IOURingSQ
nsq(long struct)

Unsafe version of sq.

public static void
nsq(long struct, IOURingSQ value)

Unsafe version of sq.

public int

Returns:

the value of the ring_fd field.
ring_fd
()

public IOURing
ring_fd(int value)

Sets the specified value to the ring_fd field.

public IOURing
set(IOURingSQ sq, IOURingCQ cq, int flags, int ring_fd, int features, int enter_ring_fd, byte int_flags)

Initializes this struct with the specified values.

public IOURing

Returns:

this struct
set
(IOURing
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).
public IOURingSQ

Returns:

a IOURingSQ view of the sq field.
sq
()

public IOURing
sq(IOURingSQ value)

Copies the specified IOURingSQ to the sq field.

public IOURing
sq(Consumer<IOURingSQ> consumer)

Passes the sq field to the specified Consumer.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

CQback to summary
public static final int CQ

The struct member offsets.

ENTER_RING_FDback to summary
public static final int ENTER_RING_FD

The struct member offsets.

FEATURESback to summary
public static final int FEATURES

The struct member offsets.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

INT_FLAGSback to summary
public static final int INT_FLAGS

The struct member offsets.

PADback to summary
public static final int PAD

The struct member offsets.

PAD2back to summary
public static final int PAD2

The struct member offsets.

RING_FDback to summary
public static final int RING_FD

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SQback to summary
public static final int SQ

The struct member offsets.

Constructor Detail

IOURingback to summary
protected IOURing(long address, ByteBuffer container)
IOURingback to summary
public IOURing(ByteBuffer container)

Creates a IOURing 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 IOURing calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static IOURing calloc(MemoryStack stack)

Returns a new IOURing 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 IOURing.Buffer calloc(int capacity, MemoryStack stack)

Returns a new IOURing.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

cqback to summary
public IOURingCQ cq()
Returns:IOURingCQ

a IOURingCQ view of the cq field.

Annotations
@NativeType:struct io_uring_cq
cqback to summary
public IOURing cq(IOURingCQ value)

Copies the specified IOURingCQ to the cq field.

cqback to summary
public IOURing cq(Consumer<IOURingCQ> consumer)

Passes the cq field to the specified Consumer.

createback to summary
protected IOURing 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 IOURing create()

Returns a new IOURing instance allocated with BufferUtils.

createback to summary
public static IOURing create(long address)

Returns a new IOURing instance for the specified memory address.

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

Returns a new IOURing.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a IOURing.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static IOURing createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
enter_ring_fdback to summary
public int enter_ring_fd()
Returns:int

the value of the enter_ring_fd field.

enter_ring_fdback to summary
public IOURing enter_ring_fd(int value)

Sets the specified value to the enter_ring_fd field.

featuresback to summary
public int features()
Returns:int

the value of the features field.

Annotations
@NativeType:unsigned int
featuresback to summary
public IOURing features(int value)

Sets the specified value to the features field.

flagsback to summary
public int flags()
Returns:int

the value of the flags field.

Annotations
@NativeType:unsigned int
flagsback to summary
public IOURing flags(int value)

Sets the specified value to the flags field.

int_flagsback to summary
public byte int_flags()
Returns:byte

the value of the int_flags field.

Annotations
@NativeType:__u8
int_flagsback to summary
public IOURing int_flags(byte value)

Sets the specified value to the int_flags field.

mallocback to summary
public static IOURing malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static IOURing malloc(MemoryStack stack)

Returns a new IOURing instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncqback to summary
public static IOURingCQ ncq(long struct)

Unsafe version of cq.

ncqback to summary
public static void ncq(long struct, IOURingCQ value)

Unsafe version of cq.

nenter_ring_fdback to summary
public static int nenter_ring_fd(long struct)

Unsafe version of enter_ring_fd.

nenter_ring_fdback to summary
public static void nenter_ring_fd(long struct, int value)

Unsafe version of enter_ring_fd.

nfeaturesback to summary
public static int nfeatures(long struct)

Unsafe version of features.

nfeaturesback to summary
public static void nfeatures(long struct, int value)

Unsafe version of features.

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

nint_flagsback to summary
public static byte nint_flags(long struct)

Unsafe version of int_flags.

nint_flagsback to summary
public static void nint_flags(long struct, byte value)

Unsafe version of int_flags.

npadback to summary
public static ByteBuffer npad(long struct)
npadback to summary
public static byte npad(long struct, int index)
npadback to summary
public static void npad(long struct, ByteBuffer value)
npadback to summary
public static void npad(long struct, int index, byte value)
npad2back to summary
public static int npad2(long struct)
npad2back to summary
public static void npad2(long struct, int value)
nring_fdback to summary
public static int nring_fd(long struct)

Unsafe version of ring_fd.

nring_fdback to summary
public static void nring_fd(long struct, int value)

Unsafe version of ring_fd.

nsqback to summary
public static IOURingSQ nsq(long struct)

Unsafe version of sq.

nsqback to summary
public static void nsq(long struct, IOURingSQ value)

Unsafe version of sq.

ring_fdback to summary
public int ring_fd()
Returns:int

the value of the ring_fd field.

ring_fdback to summary
public IOURing ring_fd(int value)

Sets the specified value to the ring_fd field.

setback to summary
public IOURing set(IOURingSQ sq, IOURingCQ cq, int flags, int ring_fd, int features, int enter_ring_fd, byte int_flags)

Initializes this struct with the specified values.

setback to summary
public IOURing set(IOURing src)

Copies the specified struct data to this struct.

Parameters
src:IOURing

the source struct

Returns:IOURing

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
sqback to summary
public IOURingSQ sq()
Returns:IOURingSQ

a IOURingSQ view of the sq field.

Annotations
@NativeType:struct io_uring_sq
sqback to summary
public IOURing sq(IOURingSQ value)

Copies the specified IOURingSQ to the sq field.

sqback to summary
public IOURing sq(Consumer<IOURingSQ> consumer)

Passes the sq field to the specified Consumer.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.system.linux.liburing back to summary

public Class IOURing.Buffer

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

An array of IOURing structs.

Field Summary

Modifier and TypeField and Description
private static final IOURing

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new IOURing.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
public IOURingCQ

Returns:

a IOURingCQ view of the cq field.
cq
()

public IOURing.Buffer
cq(IOURingCQ value)

Copies the specified IOURingCQ to the cq field.

public IOURing.Buffer
cq(Consumer<IOURingCQ> consumer)

Passes the cq field to the specified Consumer.

public int

Returns:

the value of the enter_ring_fd field.
enter_ring_fd
()

public IOURing.Buffer
enter_ring_fd(int value)

Sets the specified value to the enter_ring_fd field.

public int

Returns:

the value of the features field.
features
()

public IOURing.Buffer
features(int value)

Sets the specified value to the features field.

public int

Returns:

the value of the flags field.
flags
()

public IOURing.Buffer
flags(int value)

Sets the specified value to the flags field.

protected IOURing
public byte

Returns:

the value of the int_flags field.
int_flags
()

public IOURing.Buffer
int_flags(byte value)

Sets the specified value to the int_flags field.

public int

Returns:

the value of the ring_fd field.
ring_fd
()

public IOURing.Buffer
ring_fd(int value)

Sets the specified value to the ring_fd field.

protected IOURing.Buffer
public IOURingSQ

Returns:

a IOURingSQ view of the sq field.
sq
()

public IOURing.Buffer
sq(IOURingSQ value)

Copies the specified IOURingSQ to the sq field.

public IOURing.Buffer
sq(Consumer<IOURingSQ> consumer)

Passes the sq field to the specified Consumer.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final IOURing ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new IOURing.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 IOURing#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

cqback to summary
public IOURingCQ cq()
Returns:IOURingCQ

a IOURingCQ view of the cq field.

Annotations
@NativeType:struct io_uring_cq
cqback to summary
public IOURing.Buffer cq(IOURingCQ value)

Copies the specified IOURingCQ to the cq field.

cqback to summary
public IOURing.Buffer cq(Consumer<IOURingCQ> consumer)

Passes the cq field to the specified Consumer.

enter_ring_fdback to summary
public int enter_ring_fd()
Returns:int

the value of the enter_ring_fd field.

enter_ring_fdback to summary
public IOURing.Buffer enter_ring_fd(int value)

Sets the specified value to the enter_ring_fd field.

featuresback to summary
public int features()
Returns:int

the value of the features field.

Annotations
@NativeType:unsigned int
featuresback to summary
public IOURing.Buffer features(int value)

Sets the specified value to the features field.

flagsback to summary
public int flags()
Returns:int

the value of the flags field.

Annotations
@NativeType:unsigned int
flagsback to summary
public IOURing.Buffer flags(int value)

Sets the specified value to the flags field.

getElementFactoryback to summary
protected IOURing getElementFactory()

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

Annotations
@Override
int_flagsback to summary
public byte int_flags()
Returns:byte

the value of the int_flags field.

Annotations
@NativeType:__u8
int_flagsback to summary
public IOURing.Buffer int_flags(byte value)

Sets the specified value to the int_flags field.

ring_fdback to summary
public int ring_fd()
Returns:int

the value of the ring_fd field.

ring_fdback to summary
public IOURing.Buffer ring_fd(int value)

Sets the specified value to the ring_fd field.

selfback to summary
protected IOURing.Buffer self()

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

Annotations
@Override
sqback to summary
public IOURingSQ sq()
Returns:IOURingSQ

a IOURingSQ view of the sq field.

Annotations
@NativeType:struct io_uring_sq
sqback to summary
public IOURing.Buffer sq(IOURingSQ value)

Copies the specified IOURingSQ to the sq field.

sqback to summary
public IOURing.Buffer sq(Consumer<IOURingSQ> consumer)

Passes the sq field to the specified Consumer.