.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Transmission::Session 3pm"
.TH Transmission::Session 3pm "2022-10-16" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Transmission::Session \- Transmission session
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
See \*(L"4 Session requests\*(R" from
<https://trac.transmissionbt.com/browser/trunk/extras/rpc\-spec.txt>
.PP
This class holds data, regarding the Transmission session.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "stats"
.IX Subsection "stats"
.Vb 1
\& $stats_obj = $self\->stats;
.Ve
.PP
Returns a Transmission::Stats object.
.SS "alt_speed_down"
.IX Subsection "alt_speed_down"
.Vb 1
\& $number = $self\->alt_speed_down
.Ve
.PP
max global download speed (in K/s)
.SS "alt_speed_enabled"
.IX Subsection "alt_speed_enabled"
.Vb 1
\& $boolean = $self\->alt_speed_enabled
.Ve
.PP
true means use the alt speeds
.SS "alt_speed_time_begin"
.IX Subsection "alt_speed_time_begin"
.Vb 1
\& $number = $self\->alt_speed_time_begin
.Ve
.PP
when to turn on alt speeds (units: minutes after midnight)
.SS "alt_speed_time_enabled"
.IX Subsection "alt_speed_time_enabled"
.Vb 1
\& $boolean = $self\->alt_speed_time_enabled
.Ve
.PP
true means the scheduled on/off times are used
.SS "alt_speed_time_end"
.IX Subsection "alt_speed_time_end"
.Vb 1
\& $number = $self\->alt_speed_time_end
.Ve
.PP
when to turn off alt speeds (units: same)
.SS "alt_speed_time_day"
.IX Subsection "alt_speed_time_day"
.Vb 1
\& $number = $self\->alt_speed_time_day
.Ve
.PP
what day(s) to turn on alt speeds (look at tr_sched_day)
.SS "alt_speed_up"
.IX Subsection "alt_speed_up"
.Vb 1
\& $number = $self\->alt_speed_up
.Ve
.PP
max global upload speed (in K/s)
.SS "blocklist_enabled"
.IX Subsection "blocklist_enabled"
.Vb 1
\& $boolean = $self\->blocklist_enabled
.Ve
.PP
true means enabled
.SS "dht_enabled"
.IX Subsection "dht_enabled"
.Vb 1
\& $boolean = $self\->dht_enabled
.Ve
.PP
true means allow dht in public torrents
.SS "encryption"
.IX Subsection "encryption"
.Vb 1
\& $string = $self\->encryption
.Ve
.PP
\&\*(L"required\*(R", \*(L"preferred\*(R", \*(L"tolerated\*(R"
.SS "download_dir"
.IX Subsection "download_dir"
.Vb 1
\& $string = $self\->download_dir
.Ve
.PP
default path to download torrents
.SS "peer_limit_global"
.IX Subsection "peer_limit_global"
.Vb 1
\& $number = $self\->peer_limit_global
.Ve
.PP
maximum global number of peers
.SS "peer_limit_per_torrent"
.IX Subsection "peer_limit_per_torrent"
.Vb 1
\& $number = $self\->peer_limit_per_torrent
.Ve
.PP
maximum global number of peers
.SS "pex_enabled"
.IX Subsection "pex_enabled"
.Vb 1
\& $boolean = $self\->pex_enabled
.Ve
.PP
true means allow pex in public torrents
.SS "peer_port"
.IX Subsection "peer_port"
.Vb 1
\& $number = $self\->peer_port
.Ve
.PP
port number
.SS "peer_port_random_on_start"
.IX Subsection "peer_port_random_on_start"
.Vb 1
\& $boolean = $self\->peer_port_random_on_start
.Ve
.PP
true means pick a random peer port on launch
.SS "port_forwarding_enabled"
.IX Subsection "port_forwarding_enabled"
.Vb 1
\& $boolean = $self\->port_forwarding_enabled
.Ve
.PP
true means enabled
.SS "seedRatioLimit"
.IX Subsection "seedRatioLimit"
.Vb 1
\& $double = $self\->seedRatioLimit
.Ve
.PP
the default seed ratio for torrents to use
.SS "seedRatioLimited"
.IX Subsection "seedRatioLimited"
.Vb 1
\& $boolean = $self\->seedRatioLimited
.Ve
.PP
true if seedRatioLimit is honored by default
.SS "speed_limit_down"
.IX Subsection "speed_limit_down"
.Vb 1
\& $number = $self\->speed_limit_down
.Ve
.PP
max global download speed (in K/s)
.SS "speed_limit_down_enabled"
.IX Subsection "speed_limit_down_enabled"
.Vb 1
\& $boolean = $self\->speed_limit_down_enabled
.Ve
.PP
true means enabled
.SS "speed_limit_up"
.IX Subsection "speed_limit_up"
.Vb 1
\& $number = $self\->speed_limit_up
.Ve
.PP
max global upload speed (in K/s)
.SS "speed_limit_up_enabled"
.IX Subsection "speed_limit_up_enabled"
.Vb 1
\& $boolean = $self\->speed_limit_up_enabled
.Ve
.PP
true means enabled
.SH "LICENSE"
.IX Header "LICENSE"
.SH "AUTHOR"
.IX Header "AUTHOR"
See Transmission::Client