Transm...Session(3pm)

๐Ÿ“ฆ
version 0.0806 ยท 3 versions
, in ubuntu noble, ubuntu resolute, ubuntu stonking

๐ŸŒธ NAME ๐ŸŒธ

okay so this is Transmission::Session โ€” bestie, the manual page you're reading is Transm...Session(3pm), from the User Contributed Perl Documentation gang ๐Ÿ’…

It's literally the Transmission session. That's it, that's the girl. ๐Ÿ‘‘


โœจ DESCRIPTION โœจ

so like, the actual lore lives in "4 Session requests" over at:

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

Go read that if you want the full tea. ๐Ÿซ–

This class just holds data regarding the Transmission session. That's the whole job. She's a data holder, she's holding, she's not doing cardio about it. ๐ŸŽ€


๐Ÿฆ‹ ATTRIBUTES ๐Ÿฆ‹

every single one of these, one by one, no skipping, we don't do that here โœจ

๐ŸŒŸ stats

$stats_obj = $self->stats;

Hands you back a Transmission::Stats object. Iconic little return value. ๐Ÿ’–

๐ŸŒŸ alt_speed_down

$number = $self->alt_speed_down

max global download speed โ€” and the units are in K/s, don't forget, or you'll be out here thinking it's bytes fr fr ๐Ÿ˜ญ

๐ŸŒŸ alt_speed_enabled

$boolean = $self->alt_speed_enabled

true means the alt speeds are in use. no cap. โœ…

๐ŸŒŸ alt_speed_time_begin

$number = $self->alt_speed_time_begin

when to turn alt speeds on. units: minutes after midnight ๐Ÿ•› (so like, math required, sorry babes)

๐ŸŒŸ alt_speed_time_enabled

$boolean = $self->alt_speed_time_enabled

true means those scheduled on/off times are actually being used ๐Ÿ“…

๐ŸŒŸ alt_speed_time_end

$number = $self->alt_speed_time_end

when to turn alt speeds off. units: same as above (minutes after midnight, periodt) ๐ŸŒ™

๐ŸŒŸ alt_speed_time_day

$number = $self->alt_speed_time_day

which day(s) alt speeds turn on โ€” and bestie, you gotta look at tr_sched_day for this one, that's the vibe check ๐Ÿ—“๏ธ

๐ŸŒŸ alt_speed_up

$number = $self->alt_speed_up

max global upload speed, in K/s ๐Ÿ“ค โ€” twin of alt_speed_down, they're giving sibling energy

๐ŸŒŸ blocklist_enabled

$boolean = $self->blocklist_enabled

true means enabled. short, sweet, slayed. ๐Ÿšซ

๐ŸŒŸ dht_enabled

$boolean = $self->dht_enabled

true means allow dht in public torrents ๐Ÿ•ธ๏ธ

๐ŸŒŸ encryption

$string = $self->encryption

she returns one of these three strings, and only these three:

  • "required"
  • "preferred"
  • "tolerated"

that's the whole menu, no substitutions ๐Ÿ”

๐ŸŒŸ download_dir

$string = $self->download_dir

default path where torrents get downloaded. the home base ๐Ÿ 

๐ŸŒŸ peer_limit_global

$number = $self->peer_limit_global

maximum global number of peers ๐ŸŒ

๐ŸŒŸ peer_limit_per_torrent

$number = $self->peer_limit_per_torrent

the doc here says โ€” and I quote verbatim, bestie, I'm just the messenger ๐Ÿ’€ โ€” maximum global number of peers. yes. same sentence. that's what it says. I'm not editing the lore, I'm only narrating it ๐Ÿ™ˆ

๐ŸŒŸ pex_enabled

$boolean = $self->pex_enabled

true means allow pex in public torrents ๐Ÿ”„

๐ŸŒŸ peer_port

$number = $self->peer_port

port number. that's it. a port. a humble little number ๐Ÿ”ข

๐ŸŒŸ peer_port_random_on_start

$boolean = $self->peer_port_random_on_start

true means pick a random peer port on launch ๐ŸŽฒ chaos mode, love that for us

๐ŸŒŸ port_forwarding_enabled

$boolean = $self->port_forwarding_enabled

true means enabled ๐Ÿšชโœจ

๐ŸŒŸ seedRatioLimit

$double = $self->seedRatioLimit

the default seed ratio that torrents use ๐Ÿงฎ

๐ŸŒŸ seedRatioLimited

$boolean = $self->seedRatioLimited

true if seedRatioLimit is honored by default ๐Ÿ‘‘ (yes, it's camelCase here, no I did not do that, that's just her name)

๐ŸŒŸ speed_limit_down

$number = $self->speed_limit_down

max global download speed โ€” in K/s ๐Ÿ“ฅ

๐ŸŒŸ speed_limit_down_enabled

$boolean = $self->speed_limit_down_enabled

true means enabled โœ…

๐ŸŒŸ speed_limit_up

$number = $self->speed_limit_up

max global upload speed โ€” in K/s ๐Ÿ“ค

๐ŸŒŸ speed_limit_up_enabled

$boolean = $self->speed_limit_up_enabled

true means enabled โœ… (the symmetry, the consistency, we love to see it ๐Ÿ’…)


๐Ÿ’œ LICENSE ๐Ÿ’œ

so this section exists in the originalโ€ฆ and it's just. empty. sitting there. no text whatsoever. an icon of mystery, honestly ๐Ÿ•ณ๏ธโœจ (I'm not inventing a license for you, bestie โ€” there is nothing here, and I'm reporting that faithfully ๐Ÿ’€)


๐Ÿซถ AUTHOR ๐Ÿซถ

See Transmission::Client โ€” that's where the actual author info lives, go pay respects over there ๐Ÿ™


heads up: I kept every single attribute, every signature, every unit, every string value and every weird little description exactly as the original had them. nothing dropped, nothing added, no invented behaviour. just vibes applied on top ๐ŸŽ€

okay and finally, the lil sign-off: this page came from perl v5.36.0, dated 2022-10-16, and the manual is Transm...Session(3pm) โ€” and yes the title is truncated with ... in the original, I did not do that to her, that's just how the header looks ๐Ÿ’– bye bestie, go check your seed ratio ๐ŸŒˆ๐Ÿ“

๐Ÿ“ฆ where this page comes from