Class ImageRefProfiler

  • All Implemented Interfaces:

    public final class ImageRefProfiler
    
                        

    ImageRef memory profiler.

    ImageRefs are reference-counted. If references aren't correctly released for whatever reason, the image memory will leak. Leaking memory over time may cause out-of-memory crashes and must be avoided. The profiler can return basic and detailed information about all currently alive ImageRefs, that can be useful to track leaking ImageRefs or to confirm that there are no leaks.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Constructor Detail

      • ImageRefProfiler

        ImageRefProfiler()
    • Method Detail

      • makeSnapshot

         final static ImageRefPoolSnapshot makeSnapshot()

        Returns a snapshot of all alive ImageRefs. The snapshot contains a list of ImageRefs with information such as in-memory size. If detailed profiling is enabled (by calling enableDetailedProfiling beforehand), the profile will contain additional information such as the source from which each ImageRef has been created.

      • enableDetailedProfiling

         final static Unit enableDetailedProfiling()

        After the function is called, ImageRefs will store additional information, such as source from which they were created. This information may be important when trying to understand a profile. This function must be called BEFORE the first ImageRef is created, otherwise details may be lost.

      • diff

         final static ImageRefPoolSnapshotsDiff diff(ImageRefPoolSnapshot firstSnapshot, ImageRefPoolSnapshot secondSnapshot)

        Computes difference between two snapshots. To confirm that a particular operation doesn't leak, take a snapshot before and after the operation, and check that the diff doesn't contain any unexpected new ImageRefs.

        Parameters:
        firstSnapshot - Snapshot that was taken earlier
        secondSnapshot - Snapshot that was taken later