on_write_file Event

Hands a piece of file data to the application.

Syntax

class FTPServerWriteFileEventParams(object):
  @property
  def connection_id() -> int: ...
  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

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

Remarks

The class fires this event repeatedly during an overridden upload operation to pass file data to the application.

The handler of this event should retrieve the pending data buffer with a get_client_buffer call, and write it to the end of the file that is being uploaded.

Use the OperationStatus parameter to return the operation result back to the server.

Set OperationStatus to one of the following values: