kitetorrent/io.github.yuroyami.kitetorrent.alert/SaveResumeDataAlert

SaveResumeDataAlert

data class SaveResumeDataAlert(val torrentName: String?, val params: AddTorrentParams = AddTorrentParams()) : TorrentAlert

Generated as a response to save_resume_data() once the resume state has been written. Ported from libtorrent::save_resume_data_alert (alert_type 37).

In libtorrent this carries the populated add_torrent_params (the params member); KiteTorrent reproduces that with params, the resume-data AddTorrentParams from which write_resume_data() round-trips. Clients hand this object (or its serialised form) back to add_torrent() to restore the torrent. This alert is non-discardable.

Constructors

Link copied to clipboard
constructor(torrentName: String?, params: AddTorrentParams = AddTorrentParams())

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open override val category: Int

The bitmask of AlertCategory flags this alert belongs to. Mirrors alert::category(), which returns the concrete alert's static_category.

Link copied to clipboard
val params: AddTorrentParams

the resume payload describing how to re-add this torrent.

Link copied to clipboard
open override val torrentName: String?

the torrent's name, or null when the handle would be invalid (rendered as " - ", matching libtorrent).

Link copied to clipboard
open override val type: Int

An integer unique to this alert type, matching the C++ alert_type static constant. It can be compared against a concrete alert's ALERT_TYPE to determine the runtime type. Mirrors alert::type().

Link copied to clipboard
open override val what: String

A short string literal naming the alert type (e.g. "torrent_finished"). It carries no bundled information. Mirrors alert::what(), which in libtorrent returns alert_name(alert_type).

Functions

Link copied to clipboard
open override fun message(): String

A string describing the alert and the information bundled with it. Intended for debugging/development, not localization. Mirrors alert::message().

BSD-3-Clause ยท KiteTorrent is part of the Kite family.
Generated by Dokka