on_read_file Event

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

Syntax

class SFTPServerReadFileEventParams(object):
  @property
  def connection_id() -> int: ...
  @property
  def handle() -> str: ...
  @property
  def offset() -> int: ...
  @property
  def size() -> int: ...
  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class SFTPServer:
@property
def on_read_file() -> Callable[[SFTPServerReadFileEventParams], None]: ...
@on_read_file.setter
def on_read_file(event_hook: Callable[[SFTPServerReadFileEventParams], None]) -> None: ...

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 set_client_buffer method.

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