kitetorrent/io.github.yuroyami.kitetorrent.alert/StateUpdateAlert

StateUpdateAlert

data class StateUpdateAlert(val status: List<TorrentStatus>) : Alert

Posted in response to post_torrent_updates(), carrying the status of every torrent that changed since the last such post. Ported from libtorrent::state_update_alert (alert_type 68). Not subject to alert-mask filtering (it is only ever posted on request).

libtorrent renders state updates for <n> torrents.

Constructors

Link copied to clipboard
constructor(status: List<TorrentStatus>)

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 status: List<TorrentStatus>

the changed torrents' status snapshots.

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