kitetorrent/io.github.yuroyami.kitetorrent.alert/PeerBlockedAlert

PeerBlockedAlert

data class PeerBlockedAlert(val torrentName: String?, val endpoint: String, val reason: PeerBlockReason) : PeerAlert

Posted when an incoming peer (or one about to be added) is blocked, e.g. by the IP/port filter or protocol restrictions. Ported from libtorrent::peer_blocked_alert (alert_type 54). In libtorrent the peer id is always null for this alert.

libtorrent renders <peer-prefix>: blocked peer [<reason>].

Constructors

PeerBlockedAlert

constructor(torrentName: String?, endpoint: String, reason: PeerBlockReason)

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.

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

reason

val reason: PeerBlockReason

the reason the peer was blocked.

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