IPWorks OpenPGP 2020 Kotlin Edition

Questions / Feedback?

Progress Event

Fired as progress is made.

Syntax

public open class DefaultOpenpgpEventListener : OpenpgpEventListener {
  ...
  public override fun progress(e: OpenpgpProgressEvent) {}
  ...
}

public class OpenpgpProgressEvent {
  val bytesProcessed: Long
  val percentProcessed: Int
  val operation: Int
  var isEOF: Boolean
}

Remarks

This event is fired automatically as data is processed by the component.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

The Operation parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether a Read or Write operation is required. If the configuration settings are not set this parameter will always return 0. Possible values are:

0None
1Read
2Write

The IsEOF parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether the Read or Write operation is complete. When the Operation is Read (1) this parameter must be set to indicate that all data has been supplied to the component. When the Operation is Write (2) this value may be queried to determine when all data has been processed.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OpenPGP 2020 Kotlin Edition - Version 20.0 [Build 7941]