kitetorrent/io.github.yuroyami.kitetorrent.alert/PerformanceAlert

PerformanceAlert

data class PerformanceAlert(val torrentName: String?, val warning: PerformanceWarning) : TorrentAlert

Generated when a limit is reached that may hurt upload/download performance. Ported from libtorrent::performance_alert (alert_type 9).

libtorrent renders <name>: performance warning: <warning-label>.

Constructors

PerformanceAlert

constructor(torrentName: String?, warning: PerformanceWarning)

Types

Companion

object Companion

Properties

category

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.

torrentName

open override val torrentName: String?

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

type

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().

warning

val warning: PerformanceWarning

the specific performance warning.

what

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

message

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().