on_write_file Event

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

Syntax

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

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

Remarks

This event is fired when a request to write a data block to a file is received from the client. The ConnectionID parameter specifies the session the request originates from. The Handle parameter references the opened file where the block should be written to. Offset references the position in the file where the block of data should be written.

Use get_client_buffer method to obtain the piece of data that should be written to the file.

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