.\" 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::Torrent 3pm"
.TH Transmission::Torrent 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::Torrent \- Transmission torrent object
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
See \*(L"3.2 Torrent Mutators\*(R" and \*(L"3.3 Torrent accessors\*(R" from
<https://trac.transmissionbt.com/browser/trunk/extras/rpc\-spec.txt>
.PP
This class handles data related to a torrent known to Transmission.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Transmission::AttributeRole
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "id"
.IX Subsection "id"
.Vb 1
\& $id = $self\->id;
.Ve
.PP
Returns the id that identifies this torrent in transmission.
.SS "bandwidth_priority"
.IX Subsection "bandwidth_priority"
.Vb 1
\& $self\->bandwidth_priority($num);
.Ve
.PP
This torrent's bandwidth.
.SS "download_limit"
.IX Subsection "download_limit"
.Vb 1
\& $self\->download_limit($num);
.Ve
.PP
Maximum download speed (in K/s).
.SS "download_limited"
.IX Subsection "download_limited"
.Vb 1
\& $self\->download_limited($bool);
.Ve
.PP
True if \*(L"downloadLimit\*(R" is honored.
.SS "honors_session_limits"
.IX Subsection "honors_session_limits"
.Vb 1
\& $self\->honors_session_limits($bool);
.Ve
.PP
True if session upload limits are honored.
.SS "location"
.IX Subsection "location"
.Vb 1
\& $self\->location($str);
.Ve
.PP
New location of the torrent's content
.SS "peer_limit"
.IX Subsection "peer_limit"
.Vb 1
\& $self\->peer_limit($num);
.Ve
.PP
Maximum number of peers
.SS "seed_ratio_limit"
.IX Subsection "seed_ratio_limit"
.Vb 1
\& $self\->seed_ratio_limit($num);
.Ve
.PP
Session seeding ratio.
.SS "seed_ratio_mode"
.IX Subsection "seed_ratio_mode"
.Vb 1
\& $self\->seed_ratio_mode($num);
.Ve
.PP
Which ratio to use. See tr_ratiolimit.
.SS "upload_limit"
.IX Subsection "upload_limit"
.Vb 1
\& $self\->upload_limit($num);
.Ve
.PP
Maximum upload speed (in K/s)
.SS "upload_limited"
.IX Subsection "upload_limited"
.Vb 1
\& $self\->upload_limited($bool);
.Ve
.PP
True if \*(L"upload_limit\*(R" is honored
.SS "activity_date"
.IX Subsection "activity_date"
.Vb 1
\& $num = $self\->activity_date;
.Ve
.SS "added_date"
.IX Subsection "added_date"
.Vb 1
\& $num = $self\->added_date;
.Ve
.SS "bandwidth_priority"
.IX Subsection "bandwidth_priority"
.Vb 1
\& $num = $self\->bandwidth_priority;
.Ve
.SS "comment"
.IX Subsection "comment"
.Vb 1
\& $str = $self\->comment;
.Ve
.SS "corrupt_ever"
.IX Subsection "corrupt_ever"
.Vb 1
\& $num = $self\->corrupt_ever;
.Ve
.SS "creator"
.IX Subsection "creator"
.Vb 1
\& $str = $self\->creator;
.Ve
.SS "date_created"
.IX Subsection "date_created"
.Vb 1
\& $num = $self\->date_created;
.Ve
.SS "desired_available"
.IX Subsection "desired_available"
.Vb 1
\& $num = $self\->desired_available;
.Ve
.SS "done_date"
.IX Subsection "done_date"
.Vb 1
\& $num = $self\->done_date;
.Ve
.SS "download_dir"
.IX Subsection "download_dir"
.Vb 1
\& $str = $self\->download_dir;
.Ve
.SS "downloaded_ever"
.IX Subsection "downloaded_ever"
.Vb 1
\& $num = $self\->downloaded_ever;
.Ve
.SS "downloaders"
.IX Subsection "downloaders"
.Vb 1
\& $num = $self\->downloaders;
.Ve
.SS "download_limit"
.IX Subsection "download_limit"
.Vb 1
\& $num = $self\->download_limit;
.Ve
.SS "download_limited"
.IX Subsection "download_limited"
.Vb 1
\& $bool = $self\->download_limited;
.Ve
.SS "error"
.IX Subsection "error"
.Vb 1
\& $num = $self\->error;
.Ve
.SS "error_string"
.IX Subsection "error_string"
.Vb 1
\& $str = $self\->error_string;
.Ve
.SS "eta"
.IX Subsection "eta"
.Vb 1
\& $num = $self\->eta;
.Ve
.SS "hash_str"
.IX Subsection "hash_str"
.Vb 1
\& $str = $self\->hash_string;
.Ve
.SS "have_unchecked"
.IX Subsection "have_unchecked"
.Vb 1
\& $num = $self\->have_unchecked;
.Ve
.SS "have_valid"
.IX Subsection "have_valid"
.Vb 1
\& $num = $self\->have_valid;
.Ve
.SS "honors_session_limits"
.IX Subsection "honors_session_limits"
.Vb 1
\& $bool = $self\->honors_session_limits;
.Ve
.SS "is_private"
.IX Subsection "is_private"
.Vb 1
\& $bool = $self\->is_private;
.Ve
.SS "leechers"
.IX Subsection "leechers"
.Vb 1
\& $num = $self\->leechers;
.Ve
.SS "left_until_done"
.IX Subsection "left_until_done"
.Vb 1
\& $num = $self\->left_until_done;
.Ve
.SS "manual_announce_time"
.IX Subsection "manual_announce_time"
.Vb 1
\& $num = $self\->manual_announce_time;
.Ve
.SS "max_connected_peers"
.IX Subsection "max_connected_peers"
.Vb 1
\& $num = $self\->max_connected_peers;
.Ve
.SS "name"
.IX Subsection "name"
.Vb 1
\& $str = $self\->name;
.Ve
.SS "peer"
.IX Subsection "peer"
.Vb 1
\& $num = $self\->peer;
.Ve
.SS "peers_connected"
.IX Subsection "peers_connected"
.Vb 1
\& $num = $self\->peers_connected;
.Ve
.SS "peers_getting_from_us"
.IX Subsection "peers_getting_from_us"
.Vb 1
\& $num = $self\->peers_getting_from_us;
.Ve
.SS "peers_known"
.IX Subsection "peers_known"
.Vb 1
\& $num = $self\->peers_known;
.Ve
.SS "peers_sending_to_us"
.IX Subsection "peers_sending_to_us"
.Vb 1
\& $num = $self\->peers_sending_to_us;
.Ve
.SS "percent_done"
.IX Subsection "percent_done"
.Vb 1
\& $num = $self\->percent_done;
.Ve
.SS "pieces"
.IX Subsection "pieces"
.Vb 1
\& $str = $self\->pieces;
.Ve
.SS "piece_count"
.IX Subsection "piece_count"
.Vb 1
\& $num = $self\->piece_count;
.Ve
.SS "piece_size"
.IX Subsection "piece_size"
.Vb 1
\& $num = $self\->piece_size;
.Ve
.SS "rate_download"
.IX Subsection "rate_download"
.Vb 1
\& $num = $self\->rate_download;
.Ve
.SS "rate_upload"
.IX Subsection "rate_upload"
.Vb 1
\& $num = $self\->rate_upload;
.Ve
.SS "recheck_progress"
.IX Subsection "recheck_progress"
.Vb 1
\& $num = $self\->recheck_progress;
.Ve
.SS "seeders"
.IX Subsection "seeders"
.Vb 1
\& $num = $self\->seeders;
.Ve
.SS "seed_ratio_limit"
.IX Subsection "seed_ratio_limit"
.Vb 1
\& $num = $self\->seed_ratio_limit;
.Ve
.SS "seed_ratio_mode"
.IX Subsection "seed_ratio_mode"
.Vb 1
\& $num = $self\->seed_ratio_mode;
.Ve
.SS "size_when_done"
.IX Subsection "size_when_done"
.Vb 1
\& $num = $self\->size_when_done;
.Ve
.SS "start_date"
.IX Subsection "start_date"
.Vb 1
\& $num = $self\->start_date;
.Ve
.SS "status"
.IX Subsection "status"
.Vb 1
\& $str = $self\->status;
.Ve
.SS "swarm_speed"
.IX Subsection "swarm_speed"
.Vb 1
\& $num = $self\->swarm_speed;
.Ve
.SS "times_completed"
.IX Subsection "times_completed"
.Vb 1
\& $num = $self\->times_completed;
.Ve
.SS "total_size"
.IX Subsection "total_size"
.Vb 1
\& $num = $self\->total_size;
.Ve
.SS "torrent_file"
.IX Subsection "torrent_file"
.Vb 1
\& $str = $self\->torrent_file;
.Ve
.SS "uploaded_ever"
.IX Subsection "uploaded_ever"
.Vb 1
\& $num = $self\->uploaded_ever;
.Ve
.SS "upload_limit"
.IX Subsection "upload_limit"
.Vb 1
\& $num = $self\->upload_limit;
.Ve
.SS "upload_limited"
.IX Subsection "upload_limited"
.Vb 1
\& $bool = $self\->upload_limited;
.Ve
.SS "upload_ratio"
.IX Subsection "upload_ratio"
.Vb 1
\& $num = $self\->upload_ratio;
.Ve
.SS "webseeds_sending_to_us"
.IX Subsection "webseeds_sending_to_us"
.Vb 1
\& $num = $self\->webseeds_sending_to_us;
.Ve
.SS "files"
.IX Subsection "files"
.Vb 2
\& $array_ref = $self\->files;
\& $self\->clear_files;
.Ve
.PP
Returns an array of Transmission::Torrent::Files.
.SH "METHODS"
.IX Header "METHODS"
.SS "\s-1BUILDARGS\s0"
.IX Subsection "BUILDARGS"
.Vb 1
\& $hash_ref = $self\->BUILDARGS(\e%args);
.Ve
.PP
Convert keys in \f(CW%args\fR from \*(L"CamelCase\*(R" to \*(L"camel_case\*(R".
.SS "read"
.IX Subsection "read"
.Vb 1
\& $bool = $self\->read(\*(Aqid\*(Aq, \*(Aqname\*(Aq, \*(Aqeta\*(Aq);
.Ve
.PP
This method will refresh all requested attributes in one \s-1RPC\s0 request, while
calling one and one attribute, results in one-and-one request.
.SS "read_all"
.IX Subsection "read_all"
.Vb 1
\& $bool = $self\->read_all;
.Ve
.PP
Similar to \*(L"read\*(R", but requests all attributes.
.SS "start"
.IX Subsection "start"
See \fBTransmission::Client::start()\fR.
.SS "stop"
.IX Subsection "stop"
See \fBTransmission::Client::stop()\fR.
.SS "verify"
.IX Subsection "verify"
See \fBTransmission::Client::verify()\fR.
.SS "move"
.IX Subsection "move"
.Vb 1
\& $bool = $self\->move($path);
.Ve
.PP
Will move the torrent content to \f(CW$path\fR.
.SS "write_wanted"
.IX Subsection "write_wanted"
.Vb 1
\& $bool = $self\->write_wanted;
.Ve
.PP
Will write \*(L"wanted\*(R" information from \*(L"files\*(R" to transmission.
.SS "write_priority"
.IX Subsection "write_priority"
.Vb 1
\& $bool = $self\->write_priority;
.Ve
.PP
Will write \*(L"priorty\*(R" information from \*(L"files\*(R" to transmission.
.SH "LICENSE"
.IX Header "LICENSE"
.SH "AUTHOR"
.IX Header "AUTHOR"
See Transmission::Client.