on_read_file Event

Requests a piece of file data from the application.

Syntax

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

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

Remarks

The class fires this event repeatedly during an overridden download operation to request file data from the application.

The handler of this event should read up to Size bytes from the downloaded file, and pass them to the component with a set_client_buffer call.

Use the OperationStatus parameter to return the operation result back to the server. When the file has been read up to its end, set OperationStatus to ostEOF to tell the components that no more on_read_file calls are needed.

Set OperationStatus to one of the following values: