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

public Class IOURingBufRing

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

Layout


struct io_uring_buf_ring {
    union {
        struct {
            __u64 resv1;
            __u32 resv2;
            __u16 resv3;
            __u16 tail;
        };
        struct io_uring_buf bufs[0];
    };
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BUFS

The struct member offsets.

public static final int
RESV1

The struct member offsets.

public static final int
RESV2

The struct member offsets.

public static final int
RESV3

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TAIL

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
IOURingBufRing(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public IOURingBuf.Buffer

Returns:

a IOURingBuf.Buffer view of the bufs field.
bufs
()

public IOURingBuf

Returns:

a IOURingBuf view of the struct at the specified index of the bufs field.
bufs
(int index)

public IOURingBufRing
bufs(IOURingBuf.Buffer value)

Copies the specified IOURingBuf.Buffer to the bufs field.

public IOURingBufRing
bufs(int index, IOURingBuf value)

Copies the specified IOURingBuf at the specified index of the bufs field.

public IOURingBufRing
bufs(Consumer<IOURingBuf.Buffer> consumer)

Passes the bufs field to the specified Consumer.

public IOURingBufRing
bufs(int index, Consumer<IOURingBuf> consumer)

Passes the element at index of the bufs field to the specified Consumer.

public static IOURingBufRing
calloc()

Returns a new IOURingBufRing instance allocated with memCalloc.

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

Returns a new IOURingBufRing.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new IOURingBufRing instance allocated with BufferUtils.

public static IOURingBufRing
create(long address)

Returns a new IOURingBufRing instance for the specified memory address.

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

Returns a new IOURingBufRing.Buffer instance allocated with BufferUtils.

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

Create a IOURingBufRing.Buffer instance at the specified memory.

public static IOURingBufRing
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static IOURingBufRing
malloc()

Returns a new IOURingBufRing instance allocated with memAlloc.

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

Returns a new IOURingBufRing.Buffer instance allocated with memAlloc.

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

Returns a new IOURingBufRing instance allocated on the specified MemoryStack.

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

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

public static IOURingBuf.Buffer
nbufs(long struct)

Unsafe version of bufs.

public static IOURingBuf
nbufs(long struct, int index)

Unsafe version of bufs.

public static void
nbufs(long struct, IOURingBuf.Buffer value)

Unsafe version of bufs.

public static void
nbufs(long struct, int index, IOURingBuf value)

Unsafe version of bufs.

public static long
nresv1(long struct)

Unsafe version of resv1.

public static void
nresv1(long struct, long value)

Unsafe version of resv1.

public static int
nresv2(long struct)

Unsafe version of resv2.

public static void
nresv2(long struct, int value)

Unsafe version of resv2.

public static short
nresv3(long struct)

Unsafe version of resv3.

public static void
nresv3(long struct, short value)

Unsafe version of resv3.

public static short
ntail(long struct)

Unsafe version of tail.

public static void
ntail(long struct, short value)

Unsafe version of tail.

public long

Returns:

the value of the resv1 field.
resv1
()

public IOURingBufRing
resv1(long value)

Sets the specified value to the resv1 field.

public int

Returns:

the value of the resv2 field.
resv2
()

public IOURingBufRing
resv2(int value)

Sets the specified value to the resv2 field.

public short

Returns:

the value of the resv3 field.
resv3
()

public IOURingBufRing
resv3(short value)

Sets the specified value to the resv3 field.

public IOURingBufRing

Returns:

this struct
set
(IOURingBufRing
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 short

Returns:

the value of the tail field.
tail
()

public IOURingBufRing
tail(short value)

Sets the specified value to the tail field.

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.

BUFSback to summary
public static final int BUFS

The struct member offsets.

RESV1back to summary
public static final int RESV1

The struct member offsets.

RESV2back to summary
public static final int RESV2

The struct member offsets.

RESV3back to summary
public static final int RESV3

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TAILback to summary
public static final int TAIL

The struct member offsets.

Constructor Detail

IOURingBufRingback to summary
protected IOURingBufRing(long address, ByteBuffer container)
IOURingBufRingback to summary
public IOURingBufRing(ByteBuffer container)

Creates a IOURingBufRing 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

bufsback to summary
public IOURingBuf.Buffer bufs()
Returns:IOURingBuf.Buffer

a IOURingBuf.Buffer view of the bufs field.

Annotations
@NativeType:struct io_uring_buf[0]
bufsback to summary
public IOURingBuf bufs(int index)
Returns:IOURingBuf

a IOURingBuf view of the struct at the specified index of the bufs field.

Annotations
@NativeType:struct io_uring_buf
bufsback to summary
public IOURingBufRing bufs(IOURingBuf.Buffer value)

Copies the specified IOURingBuf.Buffer to the bufs field.

bufsback to summary
public IOURingBufRing bufs(int index, IOURingBuf value)

Copies the specified IOURingBuf at the specified index of the bufs field.

bufsback to summary
public IOURingBufRing bufs(Consumer<IOURingBuf.Buffer> consumer)

Passes the bufs field to the specified Consumer.

bufsback to summary
public IOURingBufRing bufs(int index, Consumer<IOURingBuf> consumer)

Passes the element at index of the bufs field to the specified Consumer.

callocback to summary
public static IOURingBufRing calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static IOURingBufRing calloc(MemoryStack stack)

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

Returns a new IOURingBufRing.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 IOURingBufRing 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 IOURingBufRing create()

Returns a new IOURingBufRing instance allocated with BufferUtils.

createback to summary
public static IOURingBufRing create(long address)

Returns a new IOURingBufRing instance for the specified memory address.

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

Returns a new IOURingBufRing.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a IOURingBufRing.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static IOURingBufRing createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static IOURingBufRing malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static IOURingBufRing malloc(MemoryStack stack)

Returns a new IOURingBufRing instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nbufsback to summary
public static IOURingBuf.Buffer nbufs(long struct)

Unsafe version of bufs.

nbufsback to summary
public static IOURingBuf nbufs(long struct, int index)

Unsafe version of bufs.

nbufsback to summary
public static void nbufs(long struct, IOURingBuf.Buffer value)

Unsafe version of bufs.

nbufsback to summary
public static void nbufs(long struct, int index, IOURingBuf value)

Unsafe version of bufs.

nresv1back to summary
public static long nresv1(long struct)

Unsafe version of resv1.

nresv1back to summary
public static void nresv1(long struct, long value)

Unsafe version of resv1.

nresv2back to summary
public static int nresv2(long struct)

Unsafe version of resv2.

nresv2back to summary
public static void nresv2(long struct, int value)

Unsafe version of resv2.

nresv3back to summary
public static short nresv3(long struct)

Unsafe version of resv3.

nresv3back to summary
public static void nresv3(long struct, short value)

Unsafe version of resv3.

ntailback to summary
public static short ntail(long struct)

Unsafe version of tail.

ntailback to summary
public static void ntail(long struct, short value)

Unsafe version of tail.

resv1back to summary
public long resv1()
Returns:long

the value of the resv1 field.

Annotations
@NativeType:__u64
resv1back to summary
public IOURingBufRing resv1(long value)

Sets the specified value to the resv1 field.

resv2back to summary
public int resv2()
Returns:int

the value of the resv2 field.

Annotations
@NativeType:__u32
resv2back to summary
public IOURingBufRing resv2(int value)

Sets the specified value to the resv2 field.

resv3back to summary
public short resv3()
Returns:short

the value of the resv3 field.

Annotations
@NativeType:__u16
resv3back to summary
public IOURingBufRing resv3(short value)

Sets the specified value to the resv3 field.

setback to summary
public IOURingBufRing set(IOURingBufRing src)

Copies the specified struct data to this struct.

Parameters
src:IOURingBufRing

the source struct

Returns:IOURingBufRing

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
tailback to summary
public short tail()
Returns:short

the value of the tail field.

Annotations
@NativeType:__u16
tailback to summary
public IOURingBufRing tail(short value)

Sets the specified value to the tail field.

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

public Class IOURingBufRing.Buffer

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

An array of IOURingBufRing structs.

Field Summary

Modifier and TypeField and Description
private static final IOURingBufRing

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new IOURingBufRing.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 IOURingBuf.Buffer

Returns:

a IOURingBuf.Buffer view of the bufs field.
bufs
()

public IOURingBuf

Returns:

a IOURingBuf view of the struct at the specified index of the bufs field.
bufs
(int index)

public IOURingBufRing.Buffer
bufs(IOURingBuf.Buffer value)

Copies the specified IOURingBuf.Buffer to the bufs field.

public IOURingBufRing.Buffer
bufs(int index, IOURingBuf value)

Copies the specified IOURingBuf at the specified index of the bufs field.

public IOURingBufRing.Buffer
bufs(Consumer<IOURingBuf.Buffer> consumer)

Passes the bufs field to the specified Consumer.

public IOURingBufRing.Buffer
bufs(int index, Consumer<IOURingBuf> consumer)

Passes the element at index of the bufs field to the specified Consumer.

protected IOURingBufRing
public long

Returns:

the value of the resv1 field.
resv1
()

public IOURingBufRing.Buffer
resv1(long value)

Sets the specified value to the resv1 field.

public int

Returns:

the value of the resv2 field.
resv2
()

public IOURingBufRing.Buffer
resv2(int value)

Sets the specified value to the resv2 field.

public short

Returns:

the value of the resv3 field.
resv3
()

public IOURingBufRing.Buffer
resv3(short value)

Sets the specified value to the resv3 field.

protected IOURingBufRing.Buffer
public short

Returns:

the value of the tail field.
tail
()

public IOURingBufRing.Buffer
tail(short value)

Sets the specified value to the tail field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final IOURingBufRing ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

bufsback to summary
public IOURingBuf.Buffer bufs()
Returns:IOURingBuf.Buffer

a IOURingBuf.Buffer view of the bufs field.

Annotations
@NativeType:struct io_uring_buf[0]
bufsback to summary
public IOURingBuf bufs(int index)
Returns:IOURingBuf

a IOURingBuf view of the struct at the specified index of the bufs field.

Annotations
@NativeType:struct io_uring_buf
bufsback to summary
public IOURingBufRing.Buffer bufs(IOURingBuf.Buffer value)

Copies the specified IOURingBuf.Buffer to the bufs field.

bufsback to summary
public IOURingBufRing.Buffer bufs(int index, IOURingBuf value)

Copies the specified IOURingBuf at the specified index of the bufs field.

bufsback to summary
public IOURingBufRing.Buffer bufs(Consumer<IOURingBuf.Buffer> consumer)

Passes the bufs field to the specified Consumer.

bufsback to summary
public IOURingBufRing.Buffer bufs(int index, Consumer<IOURingBuf> consumer)

Passes the element at index of the bufs field to the specified Consumer.

getElementFactoryback to summary
protected IOURingBufRing getElementFactory()

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

Annotations
@Override
resv1back to summary
public long resv1()
Returns:long

the value of the resv1 field.

Annotations
@NativeType:__u64
resv1back to summary
public IOURingBufRing.Buffer resv1(long value)

Sets the specified value to the resv1 field.

resv2back to summary
public int resv2()
Returns:int

the value of the resv2 field.

Annotations
@NativeType:__u32
resv2back to summary
public IOURingBufRing.Buffer resv2(int value)

Sets the specified value to the resv2 field.

resv3back to summary
public short resv3()
Returns:short

the value of the resv3 field.

Annotations
@NativeType:__u16
resv3back to summary
public IOURingBufRing.Buffer resv3(short value)

Sets the specified value to the resv3 field.

selfback to summary
protected IOURingBufRing.Buffer self()

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

Annotations
@Override
tailback to summary
public short tail()
Returns:short

the value of the tail field.

Annotations
@NativeType:__u16
tailback to summary
public IOURingBufRing.Buffer tail(short value)

Sets the specified value to the tail field.