kitetorrent/io.github.yuroyami.kitetorrent.alert/TorrentAlert

TorrentAlert

abstract class TorrentAlert : Alert

Base class for alerts associated with a specific torrent, ported from libtorrent::torrent_alert (include/libtorrent/alert_types.hpp).

In libtorrent this holds a torrent_handle; KiteTorrent v0 has no handle type yet, so it carries just the torrent's display torrentName (which is all the C++ message() renders: torrent_alert::message() returns torrent_name(), or " - " when the handle is invalid).

Inheritors

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
abstract 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
abstract val torrentName: String?

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

Link copied to clipboard
abstract 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
abstract 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