kitetorrent/io.github.yuroyami.kitetorrent.alert/PieceFinishedAlert

PieceFinishedAlert

data class PieceFinishedAlert(val torrentName: String?, val pieceIndex: Int) : TorrentAlert

Posted every time a piece completes downloading and passes the hash check. Ported from libtorrent::piece_finished_alert (alert_type 27).

Constructors

PieceFinishedAlert

constructor(torrentName: String?, pieceIndex: Int)

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.

pieceIndex

val pieceIndex: Int

the index of the piece that finished.

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

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