kitetorrent/io.github.yuroyami.kitetorrent.alert/ReadPieceAlert

ReadPieceAlert

data class ReadPieceAlert(val torrentName: String?, val pieceIndex: Int, val buffer: ByteArray? = null, val size: Int = 0, val errorMessage: String? = null) : TorrentAlert

Posted in response to read_piece() once the asynchronous read completes. Ported from libtorrent::read_piece_alert (alert_type 5). Non-discardable.

On success buffer holds the full piece payload and errorMessage is null; on failure the torrent is paused, buffer is null and errorMessage describes what went wrong. libtorrent renders <name>: read_piece <piece> successful or <name>: read_piece <piece> failed: <error>.

Constructors

constructor(torrentName: String?, pieceIndex: Int, buffer: ByteArray? = null, size: Int = 0, errorMessage: String? = null)

Types

object Companion

Properties

val buffer: ByteArray?

the piece data on success, or null on failure.

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.

val errorMessage: String?

the failure description, or null on success.

val pieceIndex: Int

the index of the piece that was read.

the number of bytes read (the piece size on success).

open override val torrentName: String?

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

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

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

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

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