on_transfer Event
Fired while a document transfers (delivers document).
Syntax
class S3ClientTransferEventParams(object): @property def direction() -> int: ... @property def bytes_transferred() -> int: ... @property def percent_done() -> int: ... @property def text() -> bytes: ... # In class S3Client: @property def on_transfer() -> Callable[[S3ClientTransferEventParams], None]: ... @on_transfer.setter def on_transfer(event_hook: Callable[[S3ClientTransferEventParams], None]) -> None: ...
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data is being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.