Class CUIPCMemHandle

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

    public class CUIPCMemHandle
    extends Struct
    implements NativeResource

    Layout

    
     struct CUipcMemHandle {
         char reserved[CU_IPC_HANDLE_SIZE];
     }
    • Field Detail

      • SIZEOF

        public static final int SIZEOF
        The struct size in bytes.
      • ALIGNOF

        public static final int ALIGNOF
        The struct alignment in bytes.
      • RESERVED

        public static final int RESERVED
        The struct member offsets.
    • Constructor Detail

      • CUIPCMemHandle

        public CUIPCMemHandle​(java.nio.ByteBuffer container)
        Creates a CUIPCMemHandle 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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • reserved

        public java.nio.ByteBuffer reserved()
        Returns a ByteBuffer view of the reserved field.
      • reserved

        public byte reserved​(int index)
        Returns the value at the specified index of the reserved field.
      • reserved

        public CUIPCMemHandle reserved​(java.nio.ByteBuffer value)
        Copies the specified ByteBuffer to the reserved field.
      • reserved

        public CUIPCMemHandle reserved​(int index,
                                       byte value)
        Sets the specified value at the specified index of the reserved field.
      • set

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

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

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

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

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

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

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

        public static CUIPCMemHandle mallocStack()
        Returns a new CUIPCMemHandle instance allocated on the thread-local MemoryStack.
      • callocStack

        public static CUIPCMemHandle callocStack()
        Returns a new CUIPCMemHandle instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

        public static CUIPCMemHandle mallocStack​(MemoryStack stack)
        Returns a new CUIPCMemHandle instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static CUIPCMemHandle callocStack​(MemoryStack stack)
        Returns a new CUIPCMemHandle instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • nreserved

        public static java.nio.ByteBuffer nreserved​(long struct)
        Unsafe version of reserved().
      • nreserved

        public static byte nreserved​(long struct,
                                     int index)
        Unsafe version of reserved.
      • nreserved

        public static void nreserved​(long struct,
                                     java.nio.ByteBuffer value)
        Unsafe version of reserved.
      • nreserved

        public static void nreserved​(long struct,
                                     int index,
                                     byte value)
        Unsafe version of reserved.