Class AILogStream

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

    public class AILogStream
    extends Struct
    implements NativeResource
    Represents a log stream. A log stream receives all log messages and streams them somewhere

    Member documentation

    • callback – callback to be called
    • user – user data to be passed to the callback

    Layout

    
     struct aiLogStream {
         aiLogStreamCallback callback;
         void * user;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • CALLBACK, USER

        The struct member offsets.
    • Constructor Detail

      • AILogStream

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

        public long user()
        Returns the value of the user field.
      • user

        public AILogStream user​(long value)
        Sets the specified value to the user field.
      • set

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

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

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

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

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

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

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

        public static AILogStream.Buffer callocStack​(int capacity)
        Returns a new AILogStream.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
        Parameters:
        capacity - the buffer capacity
      • callocStack

        public static AILogStream.Buffer callocStack​(int capacity,
                                                     MemoryStack stack)
        Returns a new AILogStream.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
      • nuser

        public static long nuser​(long struct)
        Unsafe version of user().
      • nuser

        public static void nuser​(long struct,
                                 long value)
        Unsafe version of user.
      • validate

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

        public static void validate​(long array,
                                    int count)
        Calls validate(long) for each struct contained in the specified struct array.
        Parameters:
        array - the struct array to validate
        count - the number of structs in array