Class IOURingCQ

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

    public class IOURingCQ
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource

    Layout

    
     struct io_uring_cq {
         unsigned * khead;
         unsigned * ktail;
         unsigned * kring_mask;
         unsigned * kring_entries;
         unsigned * kflags;
         unsigned * koverflow;
         struct io_uring_cqe * cqes;
         size_t ring_sz;
         void * ring_ptr;
         unsigned int pad[4];
     }
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  IOURingCQ.Buffer
      An array of IOURingCQ structs.
      • Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

        org.lwjgl.system.Pointer.Default
      • Nested classes/interfaces inherited from class org.lwjgl.system.Struct

        org.lwjgl.system.Struct.StructValidation
    • Constructor Summary

      Constructors 
      Constructor Description
      IOURingCQ​(java.nio.ByteBuffer container)
      Creates a IOURingCQ instance at the current position of the specified ByteBuffer container.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static IOURingCQ calloc()
      Returns a new IOURingCQ instance allocated with memCalloc.
      static IOURingCQ.Buffer calloc​(int capacity)
      Returns a new IOURingCQ.Buffer instance allocated with memCalloc.
      static IOURingCQ.Buffer calloc​(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new IOURingCQ.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      static IOURingCQ calloc​(org.lwjgl.system.MemoryStack stack)
      Returns a new IOURingCQ instance allocated on the specified MemoryStack and initializes all its bits to zero.
      IOURingCQE cqes()  
      IOURingCQ cqes​(IOURingCQE value)
      Sets the address of the specified IOURingCQE to the cqes field.
      static IOURingCQ create()
      Returns a new IOURingCQ instance allocated with BufferUtils.
      static IOURingCQ.Buffer create​(int capacity)
      Returns a new IOURingCQ.Buffer instance allocated with BufferUtils.
      static IOURingCQ create​(long address)
      Returns a new IOURingCQ instance for the specified memory address.
      static IOURingCQ.Buffer create​(long address, int capacity)
      Create a IOURingCQ.Buffer instance at the specified memory.
      static IOURingCQ createSafe​(long address)
      Like create, but returns null if address is NULL.
      static IOURingCQ.Buffer createSafe​(long address, int capacity)
      Like create, but returns null if address is NULL.
      java.nio.IntBuffer kflags​(int capacity)  
      IOURingCQ kflags​(java.nio.IntBuffer value)
      Sets the address of the specified IntBuffer to the kflags field.
      java.nio.IntBuffer khead​(int capacity)  
      IOURingCQ khead​(java.nio.IntBuffer value)
      Sets the address of the specified IntBuffer to the khead field.
      java.nio.IntBuffer koverflow​(int capacity)  
      IOURingCQ koverflow​(java.nio.IntBuffer value)
      Sets the address of the specified IntBuffer to the koverflow field.
      java.nio.IntBuffer kring_entries​(int capacity)  
      IOURingCQ kring_entries​(java.nio.IntBuffer value)
      Sets the address of the specified IntBuffer to the kring_entries field.
      java.nio.IntBuffer kring_mask​(int capacity)  
      IOURingCQ kring_mask​(java.nio.IntBuffer value)
      Sets the address of the specified IntBuffer to the kring_mask field.
      java.nio.IntBuffer ktail​(int capacity)  
      IOURingCQ ktail​(java.nio.IntBuffer value)
      Sets the address of the specified IntBuffer to the ktail field.
      static IOURingCQ malloc()
      Returns a new IOURingCQ instance allocated with memAlloc.
      static IOURingCQ.Buffer malloc​(int capacity)
      Returns a new IOURingCQ.Buffer instance allocated with memAlloc.
      static IOURingCQ.Buffer malloc​(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new IOURingCQ.Buffer instance allocated on the specified MemoryStack.
      static IOURingCQ malloc​(org.lwjgl.system.MemoryStack stack)
      Returns a new IOURingCQ instance allocated on the specified MemoryStack.
      static IOURingCQE ncqes​(long struct)
      Unsafe version of cqes().
      static void ncqes​(long struct, IOURingCQE value)
      Unsafe version of cqes.
      static java.nio.IntBuffer nkflags​(long struct, int capacity)
      Unsafe version of kflags.
      static void nkflags​(long struct, java.nio.IntBuffer value)
      Unsafe version of kflags.
      static java.nio.IntBuffer nkhead​(long struct, int capacity)
      Unsafe version of khead.
      static void nkhead​(long struct, java.nio.IntBuffer value)
      Unsafe version of khead.
      static java.nio.IntBuffer nkoverflow​(long struct, int capacity)
      Unsafe version of koverflow.
      static void nkoverflow​(long struct, java.nio.IntBuffer value)
      Unsafe version of koverflow.
      static java.nio.IntBuffer nkring_entries​(long struct, int capacity)
      Unsafe version of kring_entries.
      static void nkring_entries​(long struct, java.nio.IntBuffer value)
      Unsafe version of kring_entries.
      static java.nio.IntBuffer nkring_mask​(long struct, int capacity)
      Unsafe version of kring_mask.
      static void nkring_mask​(long struct, java.nio.IntBuffer value)
      Unsafe version of kring_mask.
      static java.nio.IntBuffer nktail​(long struct, int capacity)
      Unsafe version of ktail.
      static void nktail​(long struct, java.nio.IntBuffer value)
      Unsafe version of ktail.
      static java.nio.IntBuffer npad​(long struct)  
      static int npad​(long struct, int index)  
      static void npad​(long struct, int index, int value)  
      static void npad​(long struct, java.nio.IntBuffer value)  
      static java.nio.ByteBuffer nring_ptr​(long struct)
      Unsafe version of ring_ptr.
      static void nring_ptr​(long struct, java.nio.ByteBuffer value)
      Unsafe version of ring_ptr.
      static long nring_sz​(long struct)
      Unsafe version of ring_sz().
      static void nring_sz​(long struct, long value)
      Sets the specified value to the ring_sz field of the specified struct.
      java.nio.ByteBuffer ring_ptr()  
      IOURingCQ ring_ptr​(java.nio.ByteBuffer value)
      Sets the address of the specified ByteBuffer to the ring_ptr field.
      long ring_sz()  
      IOURingCQ set​(java.nio.IntBuffer khead, java.nio.IntBuffer ktail, java.nio.IntBuffer kring_mask, java.nio.IntBuffer kring_entries, java.nio.IntBuffer kflags, java.nio.IntBuffer koverflow, IOURingCQE cqes, java.nio.ByteBuffer ring_ptr)
      Initializes this struct with the specified values.
      IOURingCQ set​(IOURingCQ src)
      Copies the specified struct data to this struct.
      int sizeof()  
      static void validate​(long struct)
      Validates pointer members that should not be NULL.
      • Methods inherited from interface org.lwjgl.system.NativeResource

        close, free
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from class org.lwjgl.system.Pointer.Default

        address, equals, hashCode, toString
      • Methods inherited from class org.lwjgl.system.Struct

        clear, free, isNull, validate
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • KHEAD, KTAIL, KRING_MASK, KRING_ENTRIES, KFLAGS, KOVERFLOW, CQES, RING_SZ, RING_PTR, PAD

        The struct member offsets.
    • Constructor Detail

      • IOURingCQ

        public IOURingCQ​(java.nio.ByteBuffer container)
        Creates a IOURingCQ 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

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct
      • khead

        public java.nio.IntBuffer khead​(int capacity)
        Parameters:
        capacity - the number of elements in the returned buffer
        Returns:
        a IntBuffer view of the data pointed to by the khead field.
      • ktail

        public java.nio.IntBuffer ktail​(int capacity)
        Parameters:
        capacity - the number of elements in the returned buffer
        Returns:
        a IntBuffer view of the data pointed to by the ktail field.
      • kring_mask

        public java.nio.IntBuffer kring_mask​(int capacity)
        Parameters:
        capacity - the number of elements in the returned buffer
        Returns:
        a IntBuffer view of the data pointed to by the kring_mask field.
      • kring_entries

        public java.nio.IntBuffer kring_entries​(int capacity)
        Parameters:
        capacity - the number of elements in the returned buffer
        Returns:
        a IntBuffer view of the data pointed to by the kring_entries field.
      • kflags

        public java.nio.IntBuffer kflags​(int capacity)
        Parameters:
        capacity - the number of elements in the returned buffer
        Returns:
        a IntBuffer view of the data pointed to by the kflags field.
      • koverflow

        public java.nio.IntBuffer koverflow​(int capacity)
        Parameters:
        capacity - the number of elements in the returned buffer
        Returns:
        a IntBuffer view of the data pointed to by the koverflow field.
      • cqes

        public IOURingCQE cqes()
        Returns:
        a IOURingCQE view of the struct pointed to by the cqes field.
      • ring_sz

        public long ring_sz()
        Returns:
        the value of the ring_sz field.
      • ring_ptr

        public java.nio.ByteBuffer ring_ptr()
        Returns:
        a ByteBuffer view of the data pointed to by the ring_ptr field.
      • khead

        public IOURingCQ khead​(java.nio.IntBuffer value)
        Sets the address of the specified IntBuffer to the khead field.
      • ktail

        public IOURingCQ ktail​(java.nio.IntBuffer value)
        Sets the address of the specified IntBuffer to the ktail field.
      • kring_mask

        public IOURingCQ kring_mask​(java.nio.IntBuffer value)
        Sets the address of the specified IntBuffer to the kring_mask field.
      • kring_entries

        public IOURingCQ kring_entries​(java.nio.IntBuffer value)
        Sets the address of the specified IntBuffer to the kring_entries field.
      • kflags

        public IOURingCQ kflags​(java.nio.IntBuffer value)
        Sets the address of the specified IntBuffer to the kflags field.
      • koverflow

        public IOURingCQ koverflow​(java.nio.IntBuffer value)
        Sets the address of the specified IntBuffer to the koverflow field.
      • ring_ptr

        public IOURingCQ ring_ptr​(java.nio.ByteBuffer value)
        Sets the address of the specified ByteBuffer to the ring_ptr field.
      • set

        public IOURingCQ set​(java.nio.IntBuffer khead,
                             java.nio.IntBuffer ktail,
                             java.nio.IntBuffer kring_mask,
                             java.nio.IntBuffer kring_entries,
                             java.nio.IntBuffer kflags,
                             java.nio.IntBuffer koverflow,
                             IOURingCQE cqes,
                             java.nio.ByteBuffer ring_ptr)
        Initializes this struct with the specified values.
      • set

        public IOURingCQ set​(IOURingCQ src)
        Copies the specified struct data to this struct.
        Parameters:
        src - the source struct
        Returns:
        this struct
      • malloc

        public static IOURingCQ malloc()
        Returns a new IOURingCQ instance allocated with memAlloc. The instance must be explicitly freed.
      • calloc

        public static IOURingCQ calloc()
        Returns a new IOURingCQ instance allocated with memCalloc. The instance must be explicitly freed.
      • create

        public static IOURingCQ create()
        Returns a new IOURingCQ instance allocated with BufferUtils.
      • create

        public static IOURingCQ create​(long address)
        Returns a new IOURingCQ instance for the specified memory address.
      • createSafe

        @Nullable
        public static IOURingCQ createSafe​(long address)
        Like create, but returns null if address is NULL.
      • malloc

        public static IOURingCQ.Buffer malloc​(int capacity)
        Returns a new IOURingCQ.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity
      • calloc

        public static IOURingCQ.Buffer calloc​(int capacity)
        Returns a new IOURingCQ.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity
      • create

        public static IOURingCQ.Buffer create​(int capacity)
        Returns a new IOURingCQ.Buffer instance allocated with BufferUtils.
        Parameters:
        capacity - the buffer capacity
      • create

        public static IOURingCQ.Buffer create​(long address,
                                              int capacity)
        Create a IOURingCQ.Buffer instance at the specified memory.
        Parameters:
        address - the memory address
        capacity - the buffer capacity
      • createSafe

        @Nullable
        public static IOURingCQ.Buffer createSafe​(long address,
                                                  int capacity)
        Like create, but returns null if address is NULL.
      • malloc

        public static IOURingCQ malloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new IOURingCQ instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • calloc

        public static IOURingCQ calloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new IOURingCQ instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • malloc

        public static IOURingCQ.Buffer malloc​(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
        Returns a new IOURingCQ.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • calloc

        public static IOURingCQ.Buffer calloc​(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
        Returns a new IOURingCQ.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • nkhead

        public static java.nio.IntBuffer nkhead​(long struct,
                                                int capacity)
        Unsafe version of khead.
      • nktail

        public static java.nio.IntBuffer nktail​(long struct,
                                                int capacity)
        Unsafe version of ktail.
      • nkring_mask

        public static java.nio.IntBuffer nkring_mask​(long struct,
                                                     int capacity)
        Unsafe version of kring_mask.
      • nkring_entries

        public static java.nio.IntBuffer nkring_entries​(long struct,
                                                        int capacity)
        Unsafe version of kring_entries.
      • nkflags

        public static java.nio.IntBuffer nkflags​(long struct,
                                                 int capacity)
        Unsafe version of kflags.
      • nkoverflow

        public static java.nio.IntBuffer nkoverflow​(long struct,
                                                    int capacity)
        Unsafe version of koverflow.
      • ncqes

        public static IOURingCQE ncqes​(long struct)
        Unsafe version of cqes().
      • nring_sz

        public static long nring_sz​(long struct)
        Unsafe version of ring_sz().
      • nring_ptr

        public static java.nio.ByteBuffer nring_ptr​(long struct)
        Unsafe version of ring_ptr.
      • npad

        public static java.nio.IntBuffer npad​(long struct)
      • npad

        public static int npad​(long struct,
                               int index)
      • nkhead

        public static void nkhead​(long struct,
                                  java.nio.IntBuffer value)
        Unsafe version of khead.
      • nktail

        public static void nktail​(long struct,
                                  java.nio.IntBuffer value)
        Unsafe version of ktail.
      • nkring_mask

        public static void nkring_mask​(long struct,
                                       java.nio.IntBuffer value)
        Unsafe version of kring_mask.
      • nkring_entries

        public static void nkring_entries​(long struct,
                                          java.nio.IntBuffer value)
        Unsafe version of kring_entries.
      • nkflags

        public static void nkflags​(long struct,
                                   java.nio.IntBuffer value)
        Unsafe version of kflags.
      • nkoverflow

        public static void nkoverflow​(long struct,
                                      java.nio.IntBuffer value)
        Unsafe version of koverflow.
      • ncqes

        public static void ncqes​(long struct,
                                 IOURingCQE value)
        Unsafe version of cqes.
      • nring_sz

        public static void nring_sz​(long struct,
                                    long value)
        Sets the specified value to the ring_sz field of the specified struct.
      • nring_ptr

        public static void nring_ptr​(long struct,
                                     java.nio.ByteBuffer value)
        Unsafe version of ring_ptr.
      • npad

        public static void npad​(long struct,
                                java.nio.IntBuffer value)
      • npad

        public static void npad​(long struct,
                                int index,
                                int value)
      • validate

        public static void validate​(long struct)
        Validates pointer members that should not be NULL.
        Parameters:
        struct - the struct to validate