Class MemoryPressureSettings

java.lang.Object
org.javagi.base.ProxyInstance
org.webkitgtk.MemoryPressureSettings
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class MemoryPressureSettings extends ProxyInstance

A boxed type representing the settings for the memory pressure handler

WebKitMemoryPressureSettings is a boxed type that can be used to provide some custom settings to control how the memory pressure situations are handled by the different processes.

The memory pressure system implemented inside the different process will try to keep the memory usage under the defined memory limit. In order to do that, it will check the used memory with a user defined frequency and decide whether it should try to release memory. The thresholds passed will define how urgent is to release that memory.

Take into account that badly defined parameters can greatly reduce the performance of the engine. For example, setting memory limit too low with a fast poll interval can cause the process to constantly be trying to release memory.

A WebKitMemoryPressureSettings can be passed to a WebKitWebContext constructor, and the settings will be applied to all the web processes created by that context.

A WebKitMemoryPressureSettings can be passed to webkit_website_data_manager_set_memory_pressure_settings(), and the settings will be applied to all the network processes created after that call by any instance of WebKitWebsiteDataManager.

Since:
2.34

  • Constructor Details

    • MemoryPressureSettings

      public MemoryPressureSettings(MemorySegment address)
      Create a MemoryPressureSettings proxy instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • MemoryPressureSettings

      public MemoryPressureSettings()
      Create a new WebKitMemoryPressureSettings with the default values.
      Since:
      2.34

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the MemoryPressureSettings class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • copy

      public MemoryPressureSettings copy()
      Make a copy of settings.
      Returns:
      A copy of of the passed WebKitMemoryPressureSettings.
      Since:
      2.34

    • free

      public void free()
      Free the WebKitMemoryPressureSettings.
      Since:
      2.34

    • getConservativeThreshold

      public double getConservativeThreshold()
      Gets the conservative memory usage threshold.
      Returns:
      value in the (0, 1) range.
      Since:
      2.34

    • getKillThreshold

      public double getKillThreshold()
      Gets the kill memory usage threshold.
      Returns:
      positive value, can be zero.
      Since:
      2.34

    • getMemoryLimit

      public int getMemoryLimit()
      Gets the memory usage limit.
      Returns:
      current value, in megabytes.
      Since:
      2.34

    • getPollInterval

      public double getPollInterval()
      Gets the interval at which memory usage is checked.
      Returns:
      current interval value, in seconds.
      Since:
      2.34

    • getStrictThreshold

      public double getStrictThreshold()
      Gets the strict memory usage threshold.
      Returns:
      value in the (0, 1) range.
      Since:
      2.34

    • setConservativeThreshold

      public void setConservativeThreshold(double value)

      Sets the memory limit for the conservative policy to start working.

      Sets value as the fraction of the defined memory limit where the conservative policy starts working. This policy will try to reduce the memory footprint by releasing non critical memory.

      The threshold must be bigger than 0 and smaller than 1, and it must be smaller than the strict threshold defined in settings. The default value is 0.33.

      Parameters:
      value - fraction of the memory limit where the conservative policy starts working.
      Since:
      2.34

    • setKillThreshold

      public void setKillThreshold(double value)

      Sets value as the fraction of the defined memory limit where the process will be killed.

      The threshold must be a value bigger or equal to 0. A value of 0 means that the process is never killed. If the threshold is not 0, then it must be bigger than the strict threshold defined in settings. The threshold can also have values bigger than 1. The default value is 0.

      Parameters:
      value - fraction of the memory limit where the process will be killed because of excessive memory usage.
      Since:
      2.34

    • setMemoryLimit

      public void setMemoryLimit(int memoryLimit)

      Sets memoryLimit the memory limit value to settings.

      The default value is the system's RAM size with a maximum of 3GB.

      Parameters:
      memoryLimit - amount of memory (in MB) that the process is allowed to use.
      Since:
      2.34

    • setPollInterval

      public void setPollInterval(double value)

      Sets value as the poll interval used by settings.

      The poll interval value must be bigger than 0. The default value is 30 seconds.

      Parameters:
      value - period (in seconds) between memory usage measurements.
      Since:
      2.34

    • setStrictThreshold

      public void setStrictThreshold(double value)

      Sets the memory limit for the strict policy to start working.

      Sets value as the fraction of the defined memory limit where the strict policy starts working. This policy will try to reduce the memory footprint by releasing critical memory.

      The threshold must be bigger than 0 and smaller than 1. Also, it must be bigger than the conservative threshold defined in settings, and smaller than the kill threshold if the latter is not 0. The default value is 0.5.

      Parameters:
      value - fraction of the memory limit where the strict policy starts working.
      Since:
      2.34