DOKK / manpages / debian 10 / libtransmission-client-perl / Transmission::Torrent.3pm.en
Transmission::Torrent(3pm) User Contributed Perl Documentation Transmission::Torrent(3pm)

Transmission::Torrent - Transmission torrent object

See "3.2 Torrent Mutators" and "3.3 Torrent accessors" from <https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt>

This class handles data related to a torrent known to Transmission.

Transmission::AttributeRole

 $id = $self->id;

Returns the id that identifies this torrent in transmission.

 $self->bandwidth_priority($num);

This torrent's bandwidth.

 $self->download_limit($num);

Maximum download speed (in K/s).

 $self->download_limited($bool);

True if "downloadLimit" is honored.

 $self->honors_session_limits($bool);

True if session upload limits are honored.

 $self->location($str);

New location of the torrent's content

 $self->peer_limit($num);

Maximum number of peers

 $self->seed_ratio_limit($num);

Session seeding ratio.

 $self->seed_ratio_mode($num);

Which ratio to use. See tr_ratiolimit.

 $self->upload_limit($num);

Maximum upload speed (in K/s)

 $self->upload_limited($bool);

True if "upload_limit" is honored

 $num = $self->activity_date;


 $num = $self->added_date;


 $num = $self->bandwidth_priority;


 $str = $self->comment;


 $num = $self->corrupt_ever;


 $str = $self->creator;


 $num = $self->date_created;


 $num = $self->desired_available;


 $num = $self->done_date;


 $str = $self->download_dir;


 $num = $self->downloaded_ever;


 $num = $self->downloaders;


 $num = $self->download_limit;


 $bool = $self->download_limited;


 $num = $self->error;


 $str = $self->error_string;


 $num = $self->eta;


 $str = $self->hash_string;


 $num = $self->have_unchecked;


 $num = $self->have_valid;


 $bool = $self->honors_session_limits;


 $bool = $self->is_private;


 $num = $self->leechers;


 $num = $self->left_until_done;


 $num = $self->manual_announce_time;


 $num = $self->max_connected_peers;


 $str = $self->name;


 $num = $self->peer;


 $num = $self->peers_connected;


 $num = $self->peers_getting_from_us;


 $num = $self->peers_known;


 $num = $self->peers_sending_to_us;


 $num = $self->percent_done;


 $str = $self->pieces;


 $num = $self->piece_count;


 $num = $self->piece_size;


 $num = $self->rate_download;


 $num = $self->rate_upload;


 $num = $self->recheck_progress;


 $num = $self->seeders;


 $num = $self->seed_ratio_limit;


 $num = $self->seed_ratio_mode;


 $num = $self->size_when_done;


 $num = $self->start_date;


 $str = $self->status;


 $num = $self->swarm_speed;


 $num = $self->times_completed;


 $num = $self->total_size;


 $str = $self->torrent_file;


 $num = $self->uploaded_ever;


 $num = $self->upload_limit;


 $bool = $self->upload_limited;


 $num = $self->upload_ratio;


 $num = $self->webseeds_sending_to_us;


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

Returns an array of Transmission::Torrent::Files.

BUILDARGS

 $hash_ref = $self->BUILDARGS(\%args);

Convert keys in %args from "CamelCase" to "camel_case".

 $bool = $self->read('id', 'name', 'eta');

This method will refresh all requested attributes in one RPC request, while calling one and one attribute, results in one-and-one request.

 $bool = $self->read_all;

Similar to "read", but requests all attributes.

See Transmission::Client::start().

See Transmission::Client::stop().

See Transmission::Client::verify().

 $bool = $self->move($path);

Will move the torrent content to $path.

 $bool = $self->write_wanted;

Will write "wanted" information from "files" to transmission.

 $bool = $self->write_priority;

Will write "priorty" information from "files" to transmission.

See Transmission::Client.

2016-08-02 perl v5.22.2