kitetorrent/io.github.yuroyami.kitetorrent.stat/Stat

Stat

class Stat

Aggregates the six byte-stream channels of a peer connection (or the whole session). The pure-Kotlin port of libtorrent's stat (stat.hpp).

The six StatChannels, indexed by the Channel enum, split traffic by direction (upload / download) and class (BitTorrent payload, BitTorrent protocol overhead, and IP/TCP overhead). Helpers roll these up into the familiar upload_rate / total_download / ... figures the rest of libtorrent reports.

second_tick must be driven once per second (passing the real elapsed milliseconds) so each channel's smoothed rate stays in bytes/second.

Constructors

constructor()

Types

enum Channel : Enum<Stat.Channel>

The six channels of a Stat, in their fixed C++ ordinal order.

object Companion

Functions

fun addStat(downloaded: Long, uploaded: Long)

Seeds the payload totals with downloaded / uploaded bytes carried over from an earlier connection. (add_stat)

fun clear()

Resets all six channels. (clear)

downloadIpOverhead

fun downloadIpOverhead(): Int

downloadPayloadRate

fun downloadPayloadRate(): Int

fun downloadRate(): Int

operator fun get(c: Stat.Channel): StatChannel

Direct access to a channel, mirroring stat::operator[].

lastPayloadDownloaded

fun lastPayloadDownloaded(): Int

lastPayloadUploaded

fun lastPayloadUploaded(): Int

lastProtocolDownloaded

fun lastProtocolDownloaded(): Int

lastProtocolUploaded

fun lastProtocolUploaded(): Int

lowPassDownloadRate

fun lowPassDownloadRate(): Int

lowPassUploadRate

fun lowPassUploadRate(): Int

operator fun plusAssign(s: Stat)

Folds every channel of s into this one. (operator+=)

fun receivedBytes(bytesPayload: Int, bytesProtocol: Int)

Record received bytes, split into payload and protocol. (received_bytes)

fun receivedSynack(ipv6: Boolean)

Account for a received SYN-ACK plus the ACK we send back. (received_synack)

fun secondTick(tickIntervalMs: Int)

Advances every channel's smoothed rate; call once per second. (second_tick)

fun sentBytes(bytesPayload: Int, bytesProtocol: Int)

Record sent bytes, split into payload and protocol. (sent_bytes)

fun sentSyn(ipv6: Boolean)

Account for sending a TCP SYN (40 bytes IPv4, 60 IPv6). (sent_syn)

fun totalDownload(): Long

totalPayloadDownload

fun totalPayloadDownload(): Long

totalPayloadUpload

fun totalPayloadUpload(): Long

totalProtocolDownload

fun totalProtocolDownload(): Long

totalProtocolUpload

fun totalProtocolUpload(): Long

fun totalTransfer(c: Stat.Channel): Long

fun totalUpload(): Long

trancieveIpPacket

fun trancieveIpPacket(bytesTransferred: Int, ipv6: Boolean)

Charges the IP/TCP overhead of moving bytesTransferred bytes to both the upload and download IP-protocol channels, matching trancieve_ip_packet.

fun transferRate(c: Stat.Channel): Int

uploadIpOverhead

fun uploadIpOverhead(): Int

uploadPayloadRate

fun uploadPayloadRate(): Int

fun uploadRate(): Int