Transm...Torrent(3pm)

🎀 Transm...Torrent(3pm) 🎀

okay so bestie, welcome to the User Contributed Perl Documentation page for this lil' torrent object ✨ it came in under the header Transm...Torrent(3pm) because the title got truncated and honestly? iconic of it. grab a snack, we're going through every single attribute together 🫶

---

📛 NAME 📛

Transmission::Torrent — a Transmission torrent object 🌀

---

🌸 DESCRIPTION 🌸

hey so first things first, the original page tells you to go read "3.2 Torrent Mutators" and "3.3 Torrent accessors" over at:

https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt

that's the homework, bestie, go look 📚

and then, the actual tea: this class handles data related to a torrent known to Transmission 💖 like, all the info about one specific torrent? that's this class's whole job. slay.

---

👀 SEE ALSO 👀

• Transmission::AttributeRole — go read that one too, it's giving supporting cast 💜

---

💅 ATTRIBUTES 💅

so the original splits these into two flavours and honestly it's giving setters vs getters. we're keeping that energy, and yes, some names show up in both lists. that's not a typo, that's just how the page is, periodt 💀

🔥 the ones you can set (mutators) 🔥

• id — $id = $self->id; → hands you back the id that identifies this torrent in transmission 🆔
• bandwidth_priority — $self->bandwidth_priority($num); → this torrent's bandwidth ✨
• download_limit — $self->download_limit($num); → the maximum download speed, and it's in K/s 📉
• download_limited — $self->download_limited($bool); → True if "downloadLimit" is honored 💯
• honors_session_limits — $self->honors_session_limits($bool); → True if session upload limits are honored 🙌
• location — $self->location($str); → the new location of the torrent's content 📁
• peer_limit — $self->peer_limit($num); → maximum number of peers 👯
• seed_ratio_limit — $self->seed_ratio_limit($num); → session seeding ratio 🌱
• seed_ratio_mode — $self->seed_ratio_mode($num); → which ratio to use. see tr_ratiolimit 🔍
• upload_limit — $self->upload_limit($num); → maximum upload speed, also in K/s 📈
• upload_limited — $self->upload_limited($bool); → True if "upload_limit" is honored ✅

🦋 the ones you just read (accessors) 🦋

ngl the original is on a minimalist streak down here — most of these are literally just the signature and nothing else, and we respect the brevity 💖

• activity_date — $num = $self->activity_date;
• added_date — $num = $self->added_date;
• bandwidth_priority — $num = $self->bandwidth_priority; (yep, again, she contains multitudes 💅)
• comment — $str = $self->comment;
• corrupt_ever — $num = $self->corrupt_ever;
• creator — $str = $self->creator;
• date_created — $num = $self->date_created;
• desired_available — $num = $self->desired_available;
• done_date — $num = $self->done_date;
• download_dir — $str = $self->download_dir;
• downloaded_ever — $num = $self->downloaded_ever;
• downloaders — $num = $self->downloaders;
• download_limit — $num = $self->download_limit; (the getter twin of the setter above 🫶)
• download_limited — $bool = $self->download_limited;
• error — $num = $self->error;
• error_string — $str = $self->error_string;
• eta — $num = $self->eta;
• hash_str — $str = $self->hash_string; ⚠️ heads up, the attribute is called hash_str but the call is hash_string. that's exactly what the original says, no cap, don't come for me 😭
• have_unchecked — $num = $self->have_unchecked;
• have_valid — $num = $self->have_valid;
• honors_session_limits — $bool = $self->honors_session_limits;
• is_private — $bool = $self->is_private; 🤫
• leechers — $num = $self->leechers;
• left_until_done — $num = $self->left_until_done;
• manual_announce_time — $num = $self->manual_announce_time;
• max_connected_peers — $num = $self->max_connected_peers;
• name — $str = $self->name;
• peer — $num = $self->peer;
• peers_connected — $num = $self->peers_connected;
• peers_getting_from_us — $num = $self->peers_getting_from_us;
• peers_known — $num = $self->peers_known;
• peers_sending_to_us — $num = $self->peers_sending_to_us;
• percent_done — $num = $self->percent_done; 📊
• pieces — $str = $self->pieces;
• piece_count — $num = $self->piece_count;
• piece_size — $num = $self->piece_size;
• rate_download — $num = $self->rate_download;
• rate_upload — $num = $self->rate_upload;
• recheck_progress — $num = $self->recheck_progress;
• seeders — $num = $self->seeders;
• seed_ratio_limit — $num = $self->seed_ratio_limit;
• seed_ratio_mode — $num = $self->seed_ratio_mode;
• size_when_done — $num = $self->size_when_done;
• start_date — $num = $self->start_date;
• status — $str = $self->status;
• swarm_speed — $num = $self->swarm_speed;
• times_completed — $num = $self->times_completed;
• total_size — $num = $self->total_size;
• torrent_file — $str = $self->torrent_file;
• uploaded_ever — $num = $self->uploaded_ever;
• upload_limit — $num = $self->upload_limit;
• upload_limited — $bool = $self->upload_limited;
• upload_ratio — $num = $self->upload_ratio;
• webseeds_sending_to_us — $num = $self->webseeds_sending_to_us;
• files — this one's got two things going on, and it's giving overachiever:

$array_ref = $self->files;
$self->clear_files;

→ files returns an array of Transmission::Torrent::Files 🗂️ (and clear_files is hanging out right under it, yes, we keep it, no we don't delete it)

---

🛠️ METHODS 🛠️

• BUILDARGS — $hash_ref = $self->BUILDARGS(\%args); → converts the keys in %args from "CamelCase" to "camel_case" 🐪➡️🐍
• read — $bool = $self->read('id', 'name', 'eta'); this method will refresh all the requested attributes in one single RPC request. meanwhile if you call one and one attribute, you get one-and-one request. so like, batch them, bestie, your network will thank you 📡
• read_all — $bool = $self->read_all; → similar to "read", but it requests all the attributes. going feral, love that for her 🔥
• start — see Transmission::Client::start(). ▶️
• stop — see Transmission::Client::stop(). ⏹️
• verify — see Transmission::Client::verify(). 🔎
• move — $bool = $self->move($path); → will move the torrent content to $path 📦➡️📁
• write_wanted — $bool = $self->write_wanted; → will write "wanted" information from "files" to transmission ✍️
• write_priority — $bool = $self->write_priority; → will write "priorty" information from "files" to transmission. and yes, it says "priorty" in the original, that is not me misspelling it, I am simply built different and I keep the facts exact 💀

---

📜 LICENSE 📜

bestie. there is literally nothing under this heading in the original. empty. void. mysterious main character energy 🙈 we simply do not know, and I refuse to make something up.

---

✍️ AUTHOR ✍️

see Transmission::Client.

---

and that's the whole thing, you ate it 💖 this page is perl v5.36.0, dated 2022-10-16, and it lives in the User Contributed Perl Documentation — so if you enjoyed it, go read Transmission::Client and Transmission::AttributeRole next, they're the rest of the friend group 🌈⭐💜