--- name: "Transmission::Torrent" section: "3pm" platform: "linux" package: "libtransmission-client-perl" version: "0.0806-2" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/Transmission::Torrent" --- # Transmission::Torrent(3pm) Transmission torrent object ## NAME Transmission::Torrent - Transmission torrent object ## DESCRIPTION See "3.2 Torrent Mutators" and "3.3 Torrent accessors" from \ This class handles data related to a torrent known to Transmission. ## SEE ALSO Transmission::AttributeRole ## ATTRIBUTES ### id ``` $id = $self->id; ``` Returns the id that identifies this torrent in transmission. ### bandwidth\_priority ``` $self->bandwidth_priority($num); ``` This torrent's bandwidth. ### download\_limit ``` $self->download_limit($num); ``` Maximum download speed (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); ``` 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 (in K/s) ### upload\_limited ``` $self->upload_limited($bool); ``` True if "upload\_limit" is honored ### activity\_date ``` $num = $self->activity_date; ``` ### added\_date ``` $num = $self->added_date; ``` ### bandwidth\_priority ``` $num = $self->bandwidth_priority; ``` ### 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; ``` ### 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; ``` ### 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 ``` $array_ref = $self->files; $self->clear_files; ``` Returns an array of Transmission::Torrent::Files. ## METHODS ### BUILDARGS ``` $hash_ref = $self->BUILDARGS(\%args); ``` Convert keys in `%args` from "CamelCase" to "camel\_case". ### read ``` $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. ### read\_all ``` $bool = $self->read_all; ``` Similar to "read", but requests all attributes. ### 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. ## LICENSE ## AUTHOR See Transmission::Client.