IPWorks S/MIME 2020 Python Edition

Questions / Feedback?

on_transfer Event

Fired while the article text gets transferred (to or from the NewsServer ).


class SNNTPTransferEventParams(object):
  def direction() -> int: ...
  def bytes_transferred() -> int: ...
  def percent_done() -> int: ...
  def text() -> bytes: ...
  def eol() -> bool: ...

# In class SNNTP:
def on_transfer() -> Callable[[SNNTPTransferEventParams], None]: ...
def on_transfer(event_hook: Callable[[SNNTPTransferEventParams], None]) -> None: ...


One or more on_transfer events are fired during article retrieval. The Text parameter contains the portion of article data being retrieved.

The BytesTransferred parameter contains the number of bytes transferred since the beginning of the article, including header bytes.

One or more on_transfer events are also fired during article posting. Articles consist of article_text and an optional attached_file. The BytesTransferred parameter shows the number of bytes sent starting from the beginning of article_text and/or attached_file.

The on_transfer event is fired for every line of the article. For complete lines, there is no terminating newline at the end of the Text parameter, and EOL is True. The EOL parameter is False when a line is broken (usually for being too long).

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) 2021 /n software inc. - All rights reserved.
IPWorks S/MIME 2020 Python Edition - Version 20.0 [Build 7941]