Progress Event

Fires to indicate the progress of long-running vault operations.

Syntax

public class DefaultCbvaultEventListener implements CbvaultEventListener {
  ...
  public void progress(CbvaultProgressEvent e) {}
  ...
}

public class CbvaultProgressEvent {
  public int operation;
  public int progress;
  public int total;
  public boolean canStop;
  public boolean stop;
}

Remarks

This event fires anytime the component needs to report the progress of a long-running vault operation. Certain operations may cause this event to fire repeatedly.

The Operation parameter specifies which long-running operation caused this event to fire. Possible values are:

The Progress and Total parameters reflect the current and maximum progress values. Both will be 0 if the operation's progression cannot be determined.

The CanStop parameter indicates whether the application may interrupt the operation by setting the Stop parameter to true. Note that some operations can only be interrupted at certain points over the course of their lifetime.

Note: An application should not attempt to call component's methods from handlers of this event. Doing this is guaranteed to cause a deadlock.

Note: when a storage is opened concurrently in read-only mode by several applications using CBDrive or CBMemDrive component, the event will fire only in the first application. To prevent such a situation, always open a vault in read-write mode.