ReadFile Event

This event is fired when a file read request is received.

Syntax

public open class DefaultSftpserverEventListener : SftpserverEventListener {
  ...
  public override fun readFile(e: SftpserverReadFileEvent) {}
  ...
}

public class SftpserverReadFileEvent {
  val connectionID: Long
  val handle: String?
  val offset: Int
  val size: Int
  var operationStatus: Int
}

Remarks

This event is fired when a request to read block from a file is received from the client. The ConnectionID parameter specifies in which session the request was received, and Handle indicates an opened file handle. Offset andSize denote the location and size of the file piece.

Inside the event handler, pass the appropriate file chunk to the component via SetClientBuffer method.

Set OperationStatus to one of the below values according to the outcome of the request processing: