kitetorrent-session/io.github.yuroyami.kitetorrent.session.disk

Package-level declarations

Types

data class BlockRequest(val piece: Int, val offset: Int, val length: Int)

A block within a piece: piece index, byte offset into the piece, and length.

interface DiskIo

The disk subsystem boundary. This is the Kotlin counterpart of libtorrent's disk_interface (disk_interface.hpp). libtorrent dispatches each operation to a thread pool and hands back the result through a completion callback; here every operation simply suspends, so the caller writes straight-line coroutine code and the implementation is free to run blocking file I/O on an I/O dispatcher.

FileDiskIo

class FileDiskIo(storage: FileStorage, basePath: String, dispatcher: CoroutineDispatcher = Dispatchers.Default, filePriorities: IntArray? = null, storageMode: StorageMode = StorageMode.SPARSE) : DiskIo

A DiskIo backed by real files under basePath, via the platform RandomAccessStorage. Ports the piece↔file mapping logic of libtorrent's default_storage/mmap_storage (storage_utils.cpp): the torrent is a single concatenated byte stream, and a piece read/write fans out across whichever files its byte range overlaps.

InMemoryDiskIo

class InMemoryDiskIo(storage: FileStorage) : DiskIo

A DiskIo that keeps the whole torrent in one in-memory buffer. The BitTorrent piece model treats the files as a single concatenated byte stream, so piece p lives at p * pieceLength within that stream, which is exactly this buffer. Per-file boundaries only matter when writing to real files (FileDiskIo); here one buffer is the simplest correct model.

PieceHashes

data class PieceHashes(val v1: Sha1Hash?, val v2Leaves: List<Sha256Hash>)

Result of hashing a piece: its v1 SHA-1 and (for v2 torrents) per-16KiB-block SHA-256 leaves.

RandomAccessStorage

actual class RandomAccessStorage(path: String)

Android random-access file: identical to the JVM actual (java.io is available on Android).

expect class RandomAccessStorage(path: String)

Random-access file handle. This is the one thing a torrent client needs from the filesystem that has no common-stdlib equivalent: reading and writing at an arbitrary byte offset. kotlinx-io's FileSystem is stream-oriented, so this is a small platform expect/actual (RandomAccessFile on JVM/Android, POSIX fseeko/fread/fwrite on Apple).

actual class RandomAccessStorage(path: String)

Apple (iOS/macOS) random-access file via POSIX stdio with positional seeks.

actual class RandomAccessStorage(path: String)

JVM/desktop random-access file via RandomAccessFile (seek + positional read/write).

StorageMode

enum StorageMode : Enum<StorageMode>

How files are laid out on disk. This is the port of libtorrent's storage_mode_t (storage_defs.hpp).

Functions

ensureParentDirectories

actual fun ensureParentDirectories(path: String)

Create parent directories for path if needed (platform-specific).

expect fun ensureParentDirectories(path: String)

Create parent directories for path if needed (platform-specific).

actual fun ensureParentDirectories(path: String)

Create parent directories for path if needed (platform-specific).

actual fun ensureParentDirectories(path: String)

Create parent directories for path if needed (platform-specific).