Class VTTaskMonitor

java.lang.Object
ghidra.feature.vt.gui.plugin.VTTaskMonitor

public class VTTaskMonitor extends Object
A class that allows the VT application to track the currently in-use task monitor. The VTController will set this value each time it runs a VT task via VTController.runVTTask(ghidra.feature.vt.gui.task.VtTask).

In general, all background tasks should take a task monitor. However, some parts of the VT API perform time-consuming work that does not require a task monitor. This exposes a design flaw of the API. However, rather than add the task monitor to most API interfaces of VT, we use this class to allow these poorly designed APIs to use the currently running task monitor.

When using this monitor, it is expected that the client uses it only to check the state of the cancelled flag. Other monitor operations, such as updating progress and setting messages, are discouraged.

  • Constructor Details

    • VTTaskMonitor

      public VTTaskMonitor()
  • Method Details

    • getTaskMonitor

      public static ghidra.util.task.TaskMonitor getTaskMonitor()
      Returns the current in-use task monitor or a dummy monitor if there is no task running
      Returns:
      the monitor