kitetorrent/io.github.yuroyami.kitetorrent.picker/BlockState

BlockState

The four states a single block can be in. This is a pure-Kotlin port of the anonymous enum inside libtorrent's piece_picker::block_info (include/libtorrent/piece_picker.hpp).

State flows strictly forward during a healthy download: NONE → REQUESTED → WRITING → FINISHED. A block may also jump straight from NONE to WRITING or FINISHED (e.g. resume data, or a peer that hands us a whole block at once), and may fall back to NONE on abort / write-failure.

Entries

NONE

Not requested from anyone yet, so any peer can be asked for it.

REQUESTED

A request for this block is outstanding to at least one peer.

WRITING

The block arrived and is being flushed to disk.

FINISHED

The block is on disk (or counted as had, e.g. a pad block).

Properties

entries

val entries: EnumEntries<BlockState>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): BlockState

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<BlockState>

Returns an array containing the constants of this enum type, in the order they're declared.