kitetorrent/io.github.yuroyami.kitetorrent.dht/KeyDesc

KeyDesc

class KeyDesc(val name: String, val type: BdecodeNode.Type, val size: Int = 0, val flags: Int = 0)

A single required or optional key in a DHT message schema. This is the port of struct key_desc_t (include/libtorrent/kademlia/msg.hpp). Together with verifyMessage this reproduces libtorrent's verify_message_impl (src/kademlia/msg.cpp): a table of these describes the keys a query/response must contain, their bencode type, optional exact size constraints, and nesting flags.

Constructors

KeyDesc

constructor(name: String, type: BdecodeNode.Type, size: Int = 0, flags: Int = 0)

Types

Companion

object Companion

Properties

flags

val flags: Int

Bit-mask of OPTIONAL / PARSE_CHILDREN / LAST_CHILD / SIZE_DIVISIBLE.

name

val name: String

The dictionary key to look up.

size

val size: Int

Required string length (only checked for BdecodeNode.Type.STRING); 0 means "no length constraint". With SIZE_DIVISIBLE the length must instead be a multiple of this.

type

val type: BdecodeNode.Type

Required bencode type, or BdecodeNode.Type.NONE to accept any type.