Class ZSTDFrameProgression

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

    public class ZSTDFrameProgression
    extends Struct
    implements NativeResource

    Member documentation

    • ingested – nb input bytes read and buffered
    • consumed – nb input bytes actually compressed
    • produced – nb of compressed bytes generated and buffered
    • flushed – nb of compressed bytes flushed: not provided; can be tracked from caller side
    • currentJobID – mT only: latest started job nb
    • nbActiveWorkers – mT only: nb of workers actively compressing at probe time

    Layout

    
     struct ZSTD_frameProgression {
         unsigned long long ingested;
         unsigned long long consumed;
         unsigned long long produced;
         unsigned long long flushed;
         unsigned int currentJobID;
         unsigned int nbActiveWorkers;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • INGESTED, CONSUMED, PRODUCED, FLUSHED, CURRENTJOBID, NBACTIVEWORKERS

        The struct member offsets.
    • Constructor Detail

      • ZSTDFrameProgression

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

        public long ingested()
        Returns the value of the ingested field.
      • consumed

        public long consumed()
        Returns the value of the consumed field.
      • produced

        public long produced()
        Returns the value of the produced field.
      • flushed

        public long flushed()
        Returns the value of the flushed field.
      • currentJobID

        public int currentJobID()
        Returns the value of the currentJobID field.
      • nbActiveWorkers

        public int nbActiveWorkers()
        Returns the value of the nbActiveWorkers field.
      • malloc

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

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

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

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

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

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

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

        public static long ningested​(long struct)
        Unsafe version of ingested().
      • nconsumed

        public static long nconsumed​(long struct)
        Unsafe version of consumed().
      • nproduced

        public static long nproduced​(long struct)
        Unsafe version of produced().
      • nflushed

        public static long nflushed​(long struct)
        Unsafe version of flushed().
      • ncurrentJobID

        public static int ncurrentJobID​(long struct)
        Unsafe version of currentJobID().
      • nnbActiveWorkers

        public static int nnbActiveWorkers​(long struct)
        Unsafe version of nbActiveWorkers().