Torrents (elixir_torrent v0.2.0)

Copy Markdown View Source

Runtime supervisor and operations layer behind ElixirTorrent.

Most callers should use ElixirTorrent directly. This module is published in HexDocs for API completeness — it owns the dynamic supervisor that starts torrent processes and implements remove/2, stop_and_serialize/1, and related lifecycle helpers.

Summary

Functions

child_spec(_)
download(path)

Starts a new torrent download from a local .torrent path.

list()

Returns info hashes for all active torrent processes.

remove(hash, opts \\ [])

Stops a running torrent and removes it from the active list.

stats(pid)

Returns a default set of runtime stats for a torrent process.

stats(pid, fields)

Returns selected runtime fields for a torrent process as a map keyed by field.

stop_all_and_serialize()

Stops every active torrent and persists session state for each one.

stop_and_serialize(hash)

Gracefully stops a torrent and persists session state.

Functions

child_spec(_)

download(path)

@spec download(Path.t()) :: DynamicSupervisor.on_start_child()

Starts a new torrent download from a local .torrent path.

Returns {:ok, pid} on success.

list()

@spec list() :: [binary()]

Returns info hashes for all active torrent processes.

remove(hash, opts \\ [])

@spec remove(
  binary(),
  keyword()
) :: :ok | {:error, term()}

Stops a running torrent and removes it from the active list.

When :delete_data is true, downloaded files are deleted from disk after the torrent process has been stopped.

stats(pid)

@spec stats(pid()) :: {:ok, map()} | {:error, :torrent_not_found}

Returns a default set of runtime stats for a torrent process.

The default fields are: [:name, :speed, :downloaded, :bytes_size].

stats(pid, fields)

@spec stats(pid(), [atom()]) :: {:ok, map()} | {:error, :torrent_not_found}

Returns selected runtime fields for a torrent process as a map keyed by field.

Example:

Torrents.stats(pid, [:name, :speed, :downloaded, :bytes_size])

stop_all_and_serialize()

@spec stop_all_and_serialize() :: :ok

Stops every active torrent and persists session state for each one.

stop_and_serialize(hash)

@spec stop_and_serialize(binary()) :: :ok | {:error, term()}

Gracefully stops a torrent and persists session state.

Order of operations:

  1. Stop active piece downloads
  2. Disconnect all peers (BEP 3 messages, then TCP close)
  3. Tracker announce with event=stopped
  4. Write session to .elixir_torrent/state/{hash}.term
  5. Stop the torrent OTP process

Returns :ok when the torrent is not found (already stopped).