kitetorrent/io.github.yuroyami.kitetorrent.alert/TrackerAnnounceAlert

TrackerAnnounceAlert

data class TrackerAnnounceAlert(val torrentName: String?, val trackerUrl: String, val localEndpoint: String, val event: TrackerEvent, val version: ProtocolVersion = ProtocolVersion.V1) : TrackerAlert

Generated each time a tracker announce is sent (or attempted). Ported from libtorrent::tracker_announce_alert (alert_type 17).

libtorrent renders <tracker-prefix> <v1|v2> sending announce (<event>).

Constructors

constructor(torrentName: String?, trackerUrl: String, localEndpoint: String, event: TrackerEvent, version: ProtocolVersion = ProtocolVersion.V1)

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.

event

val event: TrackerEvent

the announce event sent to the tracker.

localEndpoint

open override val localEndpoint: String

the local listen interface endpoint, already formatted.

torrentName

open override val torrentName: String?

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

trackerUrl

open override val trackerUrl: String

the tracker URL being announced to.

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

version

val version: ProtocolVersion

the BitTorrent protocol version announced.

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