kitetorrent/io.github.yuroyami.kitetorrent.alert/PeerDisconnectedAlert

PeerDisconnectedAlert

data class PeerDisconnectedAlert(val torrentName: String?, val endpoint: String, val client: String = "Unknown", val socketType: String = "TCP", val operation: String = "bittorrent", val errorCategory: String = "system", val errorMessage: String, val reason: Int = 0) : PeerAlert

Generated when a peer is disconnected for any reason not covered by PeerErrorAlert. Ported from libtorrent::peer_disconnected_alert (alert_type 24).

libtorrent renders <peer-prefix> disconnecting (<socketType>) [<operation>] [<errorCategory>]: <errorMessage> (reason: <reason>).

Constructors

constructor(torrentName: String?, endpoint: String, client: String = "Unknown", socketType: String = "TCP", operation: String = "bittorrent", errorCategory: String = "system", errorMessage: String, reason: Int = 0)

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

errorCategory

val errorCategory: String

the error category name (error.category().name()).

errorMessage

val errorMessage: String

the error description.

operation

val operation: String

the operation/level where the error occurred (operation_name).

reason

val reason: Int

the numeric close-reason code (close_reason_t).

socketType

val socketType: String

the socket kind this peer was connected over.

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