kitetorrent/io.github.yuroyami.kitetorrent.alert/BlockFinishedAlert

BlockFinishedAlert

data class BlockFinishedAlert(val torrentName: String?, val endpoint: String, val client: String = "Unknown", val pieceIndex: Int, val blockIndex: Int) : PeerAlert

Generated when a block request receives a response (the block finished downloading from this peer). Ported from libtorrent::block_finished_alert (alert_type 30). Extends PeerAlert.

libtorrent renders <peer-prefix> block finished downloading (piece: <piece> block: <block>).

Constructors

BlockFinishedAlert

constructor(torrentName: String?, endpoint: String, client: String = "Unknown", pieceIndex: Int, blockIndex: Int)

Types

Companion

object Companion

Properties

blockIndex

val blockIndex: Int

the index of the block within the piece.

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.

client

open override val client: String

the identified client string for the peer id, if known.

endpoint

open override val endpoint: String

the peer's address and port, already formatted (e.g. "1.2.3.4:6881").

pieceIndex

val pieceIndex: Int

the index of the piece the block belongs to.

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