IPWorks MQ 2020 Python Edition

Questions / Feedback?

on_transfer Event

Fired during file transfer.

Syntax

class XMPPTransferEventParams(object):
  @property
  def direction() -> int: ...
  @property
  def file_id() -> str: ...
  @property
  def filename() -> str: ...
  @property
  def bytes_transferred() -> int: ...
  @property
  def percent_done() -> int: ...
  @property
  def text() -> bytes: ...
  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class XMPP:
@property
def on_transfer() -> Callable[[XMPPTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[XMPPTransferEventParams], None]) -> None: ...

Remarks

This event will fire when sending or receiving. One or more Transfer events are fired during file transfer.

The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

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.

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.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks MQ 2020 Python Edition - Version 20.0 [Build 8155]