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

public Class IOURingBufReg

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

Argument for IORING_(UN)REGISTER_PBUF_RING.

Layout


struct io_uring_buf_reg {
    __u64 ring_addr;
    __u32 ring_entries;
    __u16 bgid;
    __u16 flags;
    __u64 resv[3];
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
IOURingBufReg.Buffer

An array of IOURingBufReg structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BGID

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
RESV

The struct member offsets.

public static final int
RING_ADDR

The struct member offsets.

public static final int
RING_ENTRIES

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
IOURingBufReg(long address, ByteBuffer container)

public
IOURingBufReg(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public short

Returns:

the value of the bgid field.
bgid
()

public IOURingBufReg
bgid(short value)

Sets the specified value to the bgid field.

public static IOURingBufReg
calloc()

Returns a new IOURingBufReg instance allocated with memCalloc.

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

Returns a new IOURingBufReg.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new IOURingBufReg instance allocated with BufferUtils.

public static IOURingBufReg
create(long address)

Returns a new IOURingBufReg instance for the specified memory address.

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

Returns a new IOURingBufReg.Buffer instance allocated with BufferUtils.

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

Create a IOURingBufReg.Buffer instance at the specified memory.

public static IOURingBufReg
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public short

Returns:

the value of the flags field.
flags
()

public IOURingBufReg
flags(short value)

Sets the specified value to the flags field.

public static IOURingBufReg
malloc()

Returns a new IOURingBufReg instance allocated with memAlloc.

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

Returns a new IOURingBufReg.Buffer instance allocated with memAlloc.

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

Returns a new IOURingBufReg instance allocated on the specified MemoryStack.

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

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

public static short
nbgid(long struct)

Unsafe version of bgid.

public static void
nbgid(long struct, short value)

Unsafe version of bgid.

public static short
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, short value)

Unsafe version of flags.

public static LongBuffer
nresv(long struct)

Unsafe version of resv.

public static long
nresv(long struct, int index)

Unsafe version of resv.

public static void
nresv(long struct, LongBuffer value)

Unsafe version of resv.

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

Unsafe version of resv.

public static long
nring_addr(long struct)

Unsafe version of ring_addr.

public static void
nring_addr(long struct, long value)

Unsafe version of ring_addr.

public static int
nring_entries(long struct)

Unsafe version of ring_entries.

public static void
nring_entries(long struct, int value)

Unsafe version of ring_entries.

public LongBuffer

Returns:

a LongBuffer view of the resv field.
resv
()

public long

Returns:

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

public IOURingBufReg
resv(LongBuffer value)

Copies the specified LongBuffer to the resv field.

public IOURingBufReg
resv(int index, long value)

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

public long

Returns:

the value of the ring_addr field.
ring_addr
()

public IOURingBufReg
ring_addr(long value)

Sets the specified value to the ring_addr field.

public int

Returns:

the value of the ring_entries field.
ring_entries
()

public IOURingBufReg
ring_entries(int value)

Sets the specified value to the ring_entries field.

public IOURingBufReg
set(long ring_addr, int ring_entries, short bgid, short flags, LongBuffer resv)

Initializes this struct with the specified values.

public IOURingBufReg

Returns:

this struct
set
(IOURingBufReg
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.

BGIDback to summary
public static final int BGID

The struct member offsets.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

RESVback to summary
public static final int RESV

The struct member offsets.

RING_ADDRback to summary
public static final int RING_ADDR

The struct member offsets.

RING_ENTRIESback to summary
public static final int RING_ENTRIES

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

IOURingBufRegback to summary
protected IOURingBufReg(long address, ByteBuffer container)
IOURingBufRegback to summary
public IOURingBufReg(ByteBuffer container)

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

bgidback to summary
public short bgid()
Returns:short

the value of the bgid field.

Annotations
@NativeType:__u16
bgidback to summary
public IOURingBufReg bgid(short value)

Sets the specified value to the bgid field.

callocback to summary
public static IOURingBufReg calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static IOURingBufReg calloc(MemoryStack stack)

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

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

Returns a new IOURingBufReg instance allocated with BufferUtils.

createback to summary
public static IOURingBufReg create(long address)

Returns a new IOURingBufReg instance for the specified memory address.

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

Returns a new IOURingBufReg.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a IOURingBufReg.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static IOURingBufReg createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public short flags()
Returns:short

the value of the flags field.

Annotations
@NativeType:__u16
flagsback to summary
public IOURingBufReg flags(short value)

Sets the specified value to the flags field.

mallocback to summary
public static IOURingBufReg malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static IOURingBufReg malloc(MemoryStack stack)

Returns a new IOURingBufReg instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nbgidback to summary
public static short nbgid(long struct)

Unsafe version of bgid.

nbgidback to summary
public static void nbgid(long struct, short value)

Unsafe version of bgid.

nflagsback to summary
public static short nflags(long struct)

Unsafe version of flags.

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

Unsafe version of flags.

nresvback to summary
public static LongBuffer nresv(long struct)

Unsafe version of resv.

nresvback to summary
public static long nresv(long struct, int index)

Unsafe version of resv.

nresvback to summary
public static void nresv(long struct, LongBuffer value)

Unsafe version of resv.

nresvback to summary
public static void nresv(long struct, int index, long value)

Unsafe version of resv.

nring_addrback to summary
public static long nring_addr(long struct)

Unsafe version of ring_addr.

nring_addrback to summary
public static void nring_addr(long struct, long value)

Unsafe version of ring_addr.

nring_entriesback to summary
public static int nring_entries(long struct)

Unsafe version of ring_entries.

nring_entriesback to summary
public static void nring_entries(long struct, int value)

Unsafe version of ring_entries.

resvback to summary
public LongBuffer resv()
Returns:LongBuffer

a LongBuffer view of the resv field.

Annotations
@NativeType:__u64[3]
resvback to summary
public long resv(int index)
Returns:long

the value at the specified index of the resv field.

Annotations
@NativeType:__u64
resvback to summary
public IOURingBufReg resv(LongBuffer value)

Copies the specified LongBuffer to the resv field.

resvback to summary
public IOURingBufReg resv(int index, long value)

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

ring_addrback to summary
public long ring_addr()
Returns:long

the value of the ring_addr field.

Annotations
@NativeType:__u64
ring_addrback to summary
public IOURingBufReg ring_addr(long value)

Sets the specified value to the ring_addr field.

ring_entriesback to summary
public int ring_entries()
Returns:int

the value of the ring_entries field.

Annotations
@NativeType:__u32
ring_entriesback to summary
public IOURingBufReg ring_entries(int value)

Sets the specified value to the ring_entries field.

setback to summary
public IOURingBufReg set(long ring_addr, int ring_entries, short bgid, short flags, LongBuffer resv)

Initializes this struct with the specified values.

setback to summary
public IOURingBufReg set(IOURingBufReg src)

Copies the specified struct data to this struct.

Parameters
src:IOURingBufReg

the source struct

Returns:IOURingBufReg

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.liburing back to summary

public Class IOURingBufReg.Buffer

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

An array of IOURingBufReg structs.

Field Summary

Modifier and TypeField and Description
private static final IOURingBufReg

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new IOURingBufReg.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 short

Returns:

the value of the bgid field.
bgid
()

public IOURingBufReg.Buffer
bgid(short value)

Sets the specified value to the bgid field.

public short

Returns:

the value of the flags field.
flags
()

public IOURingBufReg.Buffer
flags(short value)

Sets the specified value to the flags field.

protected IOURingBufReg
public LongBuffer

Returns:

a LongBuffer view of the resv field.
resv
()

public long

Returns:

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

public IOURingBufReg.Buffer
resv(LongBuffer value)

Copies the specified LongBuffer to the resv field.

public IOURingBufReg.Buffer
resv(int index, long value)

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

public long

Returns:

the value of the ring_addr field.
ring_addr
()

public IOURingBufReg.Buffer
ring_addr(long value)

Sets the specified value to the ring_addr field.

public int

Returns:

the value of the ring_entries field.
ring_entries
()

public IOURingBufReg.Buffer
ring_entries(int value)

Sets the specified value to the ring_entries field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final IOURingBufReg ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

bgidback to summary
public short bgid()
Returns:short

the value of the bgid field.

Annotations
@NativeType:__u16
bgidback to summary
public IOURingBufReg.Buffer bgid(short value)

Sets the specified value to the bgid field.

flagsback to summary
public short flags()
Returns:short

the value of the flags field.

Annotations
@NativeType:__u16
flagsback to summary
public IOURingBufReg.Buffer flags(short value)

Sets the specified value to the flags field.

getElementFactoryback to summary
protected IOURingBufReg getElementFactory()

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

Annotations
@Override
resvback to summary
public LongBuffer resv()
Returns:LongBuffer

a LongBuffer view of the resv field.

Annotations
@NativeType:__u64[3]
resvback to summary
public long resv(int index)
Returns:long

the value at the specified index of the resv field.

Annotations
@NativeType:__u64
resvback to summary
public IOURingBufReg.Buffer resv(LongBuffer value)

Copies the specified LongBuffer to the resv field.

resvback to summary
public IOURingBufReg.Buffer resv(int index, long value)

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

ring_addrback to summary
public long ring_addr()
Returns:long

the value of the ring_addr field.

Annotations
@NativeType:__u64
ring_addrback to summary
public IOURingBufReg.Buffer ring_addr(long value)

Sets the specified value to the ring_addr field.

ring_entriesback to summary
public int ring_entries()
Returns:int

the value of the ring_entries field.

Annotations
@NativeType:__u32
ring_entriesback to summary
public IOURingBufReg.Buffer ring_entries(int value)

Sets the specified value to the ring_entries field.

selfback to summary
protected IOURingBufReg.Buffer self()

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

Annotations
@Override