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

public Class IOURingSQE

extends Struct<IOURingSQE>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct io_uring_sqe
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
IO submission data structure (Submission Queue Entry).

Once the submission queue entry is initialized, I/O is submitted by placing the index of the submission queue entry into the tail of the submission queue. After one or more indexes are added to the queue, and the queue tail is advanced, the enter system call can be invoked to initiate the I/O.

Layout


struct io_uring_sqe {
    __u8 opcode;
    __u8 flags;
    __u16 ioprio;
    __s32 fd;
    union {
        __u64 off;
        __u64 addr2;
        struct {
            __u32 cmd_op;
            __u32 __pad1;
        };
    };
    union {
        __u64 addr;
        __u64 splice_off_in;
    };
    __u32 len;
    union {
        __kernel_rwf_t rw_flags;
        __u32 fsync_flags;
        __u16 poll_events;
        __u32 poll32_events;
        __u32 sync_range_flags;
        __u32 msg_flags;
        __u32 timeout_flags;
        __u32 accept_flags;
        __u32 cancel_flags;
        __u32 open_flags;
        __u32 statx_flags;
        __u32 fadvise_advice;
        __u32 splice_flags;
        __u32 rename_flags;
        __u32 unlink_flags;
        __u32 hardlink_flags;
        __u32 xattr_flags;
        __u32 msg_ring_flags;
        __u32 uring_cmd_flags;
    };
    __u64 user_data;
    union {
        __u16 buf_index;
        __u16 buf_group;
    };
    __u16 personality;
    union {
        __s32 splice_fd_in;
        __u32 file_index;
        struct {
            __u16 addr_len;
            __u16 __pad3[1];
        };
    };
    union {
        struct {
            __u64 addr3;
            __u64 __pad2[1];
        };
        __u8 cmd[0];
    };
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
IOURingSQE.Buffer

An array of IOURingSQE structs.

Field Summary

Modifier and TypeField and Description
public static final int
__PAD1

The struct member offsets.

public static final int
__PAD2

The struct member offsets.

public static final int
__PAD3

The struct member offsets.

public static final int
ACCEPT_FLAGS

The struct member offsets.

public static final int
ADDR

The struct member offsets.

public static final int
ADDR2

The struct member offsets.

public static final int
ADDR3

The struct member offsets.

public static final int
ADDR_LEN

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BUF_GROUP

The struct member offsets.

public static final int
BUF_INDEX

The struct member offsets.

public static final int
CANCEL_FLAGS

The struct member offsets.

public static final int
CMD

The struct member offsets.

public static final int
CMD_OP

The struct member offsets.

public static final int
FADVISE_ADVICE

The struct member offsets.

public static final int
FD

The struct member offsets.

public static final int
FILE_INDEX

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
FSYNC_FLAGS

The struct member offsets.

public static final int
IOPRIO

The struct member offsets.

public static final int
LEN

The struct member offsets.

public static final int
MSG_FLAGS

The struct member offsets.

public static final int
MSG_RING_FLAGS

The struct member offsets.

public static final int
OFF

The struct member offsets.

public static final int
OPCODE

The struct member offsets.

public static final int
OPEN_FLAGS

The struct member offsets.

public static final int
PERSONALITY

The struct member offsets.

public static final int
POLL32_EVENTS

The struct member offsets.

public static final int
POLL_EVENTS

The struct member offsets.

public static final int
RENAME_FLAGS

The struct member offsets.

public static final int
RW_FLAGS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SPLICE_FD_IN

The struct member offsets.

public static final int
SPLICE_FLAGS

The struct member offsets.

public static final int
SPLICE_OFF_IN

The struct member offsets.

public static final int
STATX_FLAGS

The struct member offsets.

public static final int
SYNC_RANGE_FLAGS

The struct member offsets.

public static final int
TIMEOUT_FLAGS

The struct member offsets.

public static final int
URING_CMD_FLAGS

The struct member offsets.

public static final int
USER_DATA

The struct member offsets.

public static final int
XATTR_FLAGS

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
IOURingSQE(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the __pad1 field.
__pad1()

public IOURingSQE
__pad1(int value)

Sets the specified value to the __pad1 field.

public LongBuffer

Returns:

a LongBuffer view of the __pad2 field.
__pad2()

public long

Returns:

the value at the specified index of the __pad2 field.
__pad2(int index)

public IOURingSQE
__pad2(LongBuffer value)

Copies the specified LongBuffer to the __pad2 field.

public IOURingSQE
__pad2(int index, long value)

Sets the specified value at the specified index of the __pad2 field.

public ShortBuffer

Returns:

a ShortBuffer view of the __pad3 field.
__pad3()

public short

Returns:

the value at the specified index of the __pad3 field.
__pad3(int index)

public IOURingSQE
__pad3(ShortBuffer value)

Copies the specified ShortBuffer to the __pad3 field.

public IOURingSQE
__pad3(int index, short value)

Sets the specified value at the specified index of the __pad3 field.

public int

Returns:

the value of the accept_flags field.
accept_flags()

public IOURingSQE
accept_flags(int value)

Sets the specified value to the accept_flags field.

public long
addr()

pointer to buffer or iovecs

public IOURingSQE
addr(long value)

Sets the specified value to the addr field.

public long

Returns:

the value of the addr2 field.
addr2()

public IOURingSQE
addr2(long value)

Sets the specified value to the addr2 field.

public long

Returns:

the value of the addr3 field.
addr3()

public IOURingSQE
addr3(long value)

Sets the specified value to the addr3 field.

public short

Returns:

the value of the addr_len field.
addr_len()

public IOURingSQE
addr_len(short value)

Sets the specified value to the addr_len field.

public short
buf_group()

for grouped buffer selection

public IOURingSQE
buf_group(short value)

Sets the specified value to the buf_group field.

public short
buf_index()

an index into an array of fixed buffers, and is only valid if fixed buffers were registered

public IOURingSQE
buf_index(short value)

Sets the specified value to the buf_index field.

public static IOURingSQE
calloc()

Returns a new IOURingSQE instance allocated with memCalloc.

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

Returns a new IOURingSQE.Buffer instance allocated with memCalloc.

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

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

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

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

public int

Returns:

the value of the cancel_flags field.
cancel_flags()

public IOURingSQE
cancel_flags(int value)

Sets the specified value to the cancel_flags field.

public ByteBuffer
cmd()

If the ring is initialized with SETUP_SQE128, then this field is used for 80 bytes of arbitrary command data

public byte
cmd(int index)

If the ring is initialized with SETUP_SQE128, then this field is used for 80 bytes of arbitrary command data

public IOURingSQE
cmd(ByteBuffer value)

Copies the specified ByteBuffer to the cmd field.

public IOURingSQE
cmd(int index, byte value)

Sets the specified value at the specified index of the cmd field.

public int

Returns:

the value of the cmd_op field.
cmd_op()

public IOURingSQE
cmd_op(int value)

Sets the specified value to the cmd_op field.

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

Returns a new IOURingSQE instance allocated with BufferUtils.

public static IOURingSQE
create(long address)

Returns a new IOURingSQE instance for the specified memory address.

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

Returns a new IOURingSQE.Buffer instance allocated with BufferUtils.

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

Create a IOURingSQE.Buffer instance at the specified memory.

public static IOURingSQE
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int

Returns:

the value of the fadvise_advice field.
fadvise_advice()

public IOURingSQE
fadvise_advice(int value)

Sets the specified value to the fadvise_advice field.

public int
fd()

specifies the file descriptor against which the operation will be performed

public IOURingSQE
fd(int value)

Sets the specified value to the fd field.

public int

Returns:

the value of the file_index field.
file_index()

public IOURingSQE
file_index(int value)

Sets the specified value to the file_index field.

public byte
flags()

IOSQE_ flags.

public IOURingSQE
flags(byte value)

Sets the specified value to the flags field.

public int
fsync_flags()

may contain either 0, for a normal file integrity sync, or FSYNC_DATASYNC to provide data sync only semantics.

public IOURingSQE
fsync_flags(int value)

Sets the specified value to the fsync_flags field.

public short
ioprio()

specifies the I/O priority.

public IOURingSQE
ioprio(short value)

Sets the specified value to the ioprio field.

public int
len()

buffer size or number of iovecs

public IOURingSQE
len(int value)

Sets the specified value to the len field.

public static IOURingSQE
malloc()

Returns a new IOURingSQE instance allocated with memAlloc.

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

Returns a new IOURingSQE.Buffer instance allocated with memAlloc.

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

Returns a new IOURingSQE instance allocated on the specified MemoryStack.

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

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

public int

Returns:

the value of the msg_flags field.
msg_flags()

public IOURingSQE
msg_flags(int value)

Sets the specified value to the msg_flags field.

public int

Returns:

the value of the msg_ring_flags field.
msg_ring_flags()

public IOURingSQE
msg_ring_flags(int value)

Sets the specified value to the msg_ring_flags field.

public static int
n__pad1(long struct)

public static void
n__pad1(long struct, int value)

public static LongBuffer
n__pad2(long struct)

public static long
n__pad2(long struct, int index)

public static void
n__pad2(long struct, LongBuffer value)

public static void
n__pad2(long struct, int index, long value)

public static ShortBuffer
n__pad3(long struct)

public static short
n__pad3(long struct, int index)

public static void
n__pad3(long struct, ShortBuffer value)

public static void
n__pad3(long struct, int index, short value)

public static int
naccept_flags(long struct)

Unsafe version of accept_flags.

public static void
naccept_flags(long struct, int value)

Unsafe version of accept_flags.

public static long
naddr(long struct)

Unsafe version of addr.

public static void
naddr(long struct, long value)

Unsafe version of addr.

public static long
naddr2(long struct)

Unsafe version of addr2.

public static void
naddr2(long struct, long value)

Unsafe version of addr2.

public static long
naddr3(long struct)

Unsafe version of addr3.

public static void
naddr3(long struct, long value)

Unsafe version of addr3.

public static short
naddr_len(long struct)

Unsafe version of addr_len.

public static void
naddr_len(long struct, short value)

Unsafe version of addr_len.

public static short
nbuf_group(long struct)

Unsafe version of buf_group.

public static void
nbuf_group(long struct, short value)

Unsafe version of buf_group.

public static short
nbuf_index(long struct)

Unsafe version of buf_index.

public static void
nbuf_index(long struct, short value)

Unsafe version of buf_index.

public static int
ncancel_flags(long struct)

Unsafe version of cancel_flags.

public static void
ncancel_flags(long struct, int value)

Unsafe version of cancel_flags.

public static ByteBuffer
ncmd(long struct)

Unsafe version of cmd.

public static byte
ncmd(long struct, int index)

Unsafe version of cmd.

public static void
ncmd(long struct, ByteBuffer value)

Unsafe version of cmd.

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

Unsafe version of cmd.

public static int
ncmd_op(long struct)

Unsafe version of cmd_op.

public static void
ncmd_op(long struct, int value)

Unsafe version of cmd_op.

public static int
nfadvise_advice(long struct)

Unsafe version of fadvise_advice.

public static void
nfadvise_advice(long struct, int value)

Unsafe version of fadvise_advice.

public static int
nfd(long struct)

Unsafe version of fd.

public static void
nfd(long struct, int value)

Unsafe version of fd.

public static int
nfile_index(long struct)

Unsafe version of file_index.

public static void
nfile_index(long struct, int value)

Unsafe version of file_index.

public static byte
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, byte value)

Unsafe version of flags.

public static int
nfsync_flags(long struct)

Unsafe version of fsync_flags.

public static void
nfsync_flags(long struct, int value)

Unsafe version of fsync_flags.

public static short
nioprio(long struct)

Unsafe version of ioprio.

public static void
nioprio(long struct, short value)

Unsafe version of ioprio.

public static int
nlen(long struct)

Unsafe version of len.

public static void
nlen(long struct, int value)

Unsafe version of len.

public static int
nmsg_flags(long struct)

Unsafe version of msg_flags.

public static void
nmsg_flags(long struct, int value)

Unsafe version of msg_flags.

public static int
nmsg_ring_flags(long struct)

Unsafe version of msg_ring_flags.

public static void
nmsg_ring_flags(long struct, int value)

Unsafe version of msg_ring_flags.

public static long
noff(long struct)

Unsafe version of off.

public static void
noff(long struct, long value)

Unsafe version of off.

public static byte
nopcode(long struct)

Unsafe version of opcode.

public static void
nopcode(long struct, byte value)

Unsafe version of opcode.

public static int
nopen_flags(long struct)

Unsafe version of open_flags.

public static void
nopen_flags(long struct, int value)

Unsafe version of open_flags.

public static short
npersonality(long struct)

Unsafe version of personality.

public static void
npersonality(long struct, short value)

Unsafe version of personality.

public static int
npoll32_events(long struct)

Unsafe version of poll32_events.

public static void
npoll32_events(long struct, int value)

Unsafe version of poll32_events.

public static short
npoll_events(long struct)

Unsafe version of poll_events.

public static void
npoll_events(long struct, short value)

Unsafe version of poll_events.

public static int
nrename_flags(long struct)

Unsafe version of rename_flags.

public static void
nrename_flags(long struct, int value)

Unsafe version of rename_flags.

public static int
nrw_flags(long struct)

Unsafe version of rw_flags.

public static void
nrw_flags(long struct, int value)

Unsafe version of rw_flags.

public static int
nsplice_fd_in(long struct)

Unsafe version of splice_fd_in.

public static void
nsplice_fd_in(long struct, int value)

Unsafe version of splice_fd_in.

public static int
nsplice_flags(long struct)

Unsafe version of splice_flags.

public static void
nsplice_flags(long struct, int value)

Unsafe version of splice_flags.

public static long
nsplice_off_in(long struct)

Unsafe version of splice_off_in.

public static void
nsplice_off_in(long struct, long value)

Unsafe version of splice_off_in.

public static int
nstatx_flags(long struct)

Unsafe version of statx_flags.

public static void
nstatx_flags(long struct, int value)

Unsafe version of statx_flags.

public static int
nsync_range_flags(long struct)

Unsafe version of sync_range_flags.

public static void
nsync_range_flags(long struct, int value)

Unsafe version of sync_range_flags.

public static int
ntimeout_flags(long struct)

Unsafe version of timeout_flags.

public static void
ntimeout_flags(long struct, int value)

Unsafe version of timeout_flags.

public static int
nuring_cmd_flags(long struct)

Unsafe version of uring_cmd_flags.

public static void
nuring_cmd_flags(long struct, int value)

Unsafe version of uring_cmd_flags.

public static long
nuser_data(long struct)

Unsafe version of user_data.

public static void
nuser_data(long struct, long value)

Unsafe version of user_data.

public static int
nxattr_flags(long struct)

Unsafe version of xattr_flags.

public static void
nxattr_flags(long struct, int value)

Unsafe version of xattr_flags.

public long
off()

offset into file

public IOURingSQE
off(long value)

Sets the specified value to the off field.

public byte
opcode()

type of operation for this sqe

public IOURingSQE
opcode(byte value)

Sets the specified value to the opcode field.

public int

Returns:

the value of the open_flags field.
open_flags()

public IOURingSQE
open_flags(int value)

Sets the specified value to the open_flags field.

public short
personality()

the credentials id to use for this operation.

public IOURingSQE
personality(short value)

Sets the specified value to the personality field.

public int
poll32_events()

word-reversed for BE

public IOURingSQE
poll32_events(int value)

Sets the specified value to the poll32_events field.

public short
poll_events()

the bits that may be set in poll_events are defined in <poll.h>, and documented in poll(2)

public IOURingSQE
poll_events(short value)

Sets the specified value to the poll_events field.

public int

Returns:

the value of the rename_flags field.
rename_flags()

public IOURingSQE
rename_flags(int value)

Sets the specified value to the rename_flags field.

public int
rw_flags()

specified for read and write operations, contains a bitwise OR of per-I/O flags, as described in the preadv2(2) man page

public IOURingSQE
rw_flags(int value)

Sets the specified value to the rw_flags field.

public IOURingSQE

Returns:

this struct
set(IOURingSQE
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 int

Returns:

the value of the splice_fd_in field.
splice_fd_in()

public IOURingSQE
splice_fd_in(int value)

Sets the specified value to the splice_fd_in field.

public int

Returns:

the value of the splice_flags field.
splice_flags()

public IOURingSQE
splice_flags(int value)

Sets the specified value to the splice_flags field.

public long

Returns:

the value of the splice_off_in field.
splice_off_in()

public IOURingSQE
splice_off_in(long value)

Sets the specified value to the splice_off_in field.

public int

Returns:

the value of the statx_flags field.
statx_flags()

public IOURingSQE
statx_flags(int value)

Sets the specified value to the statx_flags field.

public int

Returns:

the value of the sync_range_flags field.
sync_range_flags()

public IOURingSQE
sync_range_flags(int value)

Sets the specified value to the sync_range_flags field.

public int

Returns:

the value of the timeout_flags field.
timeout_flags()

public IOURingSQE
timeout_flags(int value)

Sets the specified value to the timeout_flags field.

public int

Returns:

the value of the uring_cmd_flags field.
uring_cmd_flags()

public IOURingSQE
uring_cmd_flags(int value)

Sets the specified value to the uring_cmd_flags field.

public long
user_data()

an application-supplied value that will be copied into the completion queue entry

public IOURingSQE
user_data(long value)

Sets the specified value to the user_data field.

public int

Returns:

the value of the xattr_flags field.
xattr_flags()

public IOURingSQE
xattr_flags(int value)

Sets the specified value to the xattr_flags field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate