Transfer Event

Fired during file download/upload.

Syntax

public open class DefaultSftpEventListener : SftpEventListener {
  ...
  public override fun transfer(e: SftpTransferEvent) {}
  ...
}

public class SftpTransferEvent {
  val direction: Int
  val localFile: String?
  val remoteFile: String?
  val bytesTransferred: Long
  val percentDone: Int
  val text: ByteArray?
  var cancel: Boolean
}

Remarks

One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

LocalFile identifies the local file. RemoteFile is the remote file.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

To cancel the current transfer set Cancel to true.