NAME
P2P::Transmission::Torrent - Transmission Torrent object
DESCRIPTION
P2P::Transmission::Torrent objects are generated by the lookup() and torrents() methods of the parent class P2P::Transmission. With the exception of the start, stop, and remove methods, this subclass is a read-only representation of a currently active torrent.
The two types of read-only methods implemented by this class are info methods which relate to information contained in the .torrent file and status methods which relate to information about the download itself.
Unless otherwise noted, the read-only accessors return a scalar value on success or undef on failure.
METHODS
remove-
Unload this torrent from Transmission.
start-
Activate this torrent
Note: has no effect if torrent is running stop-
Deactivates this torrent
Note: has no effect if torrent isn't running
INFO METHODS
descriptions taken from transmission/doc/ipcproto.txtcomment-
string, comment from torrent file
creator-
string, creator of torrent file
date-
integer, date of torrent creation (unix time_t format)
files-
array of hashes, keyed by
nameandsize hash-
string, SHA-1 info hash in hex (unique identifier)
name-
string, torrent name
path-
string, path to .torrent file
private-
boolean, true if the torrent is private
saved-
boolean, true if a copy of this torrent was saved
size-
integer, total size of all files in bytes
trackers-
array of hashes, keyed by
announce,address,port, andscrapeNote: this method represents the available trackers
STATUS METHODS
completed-
integer, bytes of data downloaded and verified
download_speed-
integer, download speed in bytes per second
download_total-
integer, total bytes downloaded so far
error-
string, see ipcproto.txt for more info
error_message-
string, printable error message
eta-
integer, estimated seconds until downloading is finished
peers_downloading-
integer, peers downloading from us
peers_from-
hash, keyed by
tracker,incoming,pex, andcache peers_total-
integer, total connected peers
peers_uploading-
integer, peers uploading to us
running-
boolean, false if torrent is stopped or stopping
scrape_completed-
integer, total completed peers as reported by tracker
scrape_leechers-
integer, current leechers as reported by tracker
scrape_seeders-
integer, current, seeders as reported by tracker
state-
string, see ipcinfo.txt for more info
swarm_speed-
integer, swarm speed in bytes per second
tracker-
hash, keyed by
announce,address,port, andscrapeNote: this method represents the active tracker upload_speed-
integer, upload speed in bytes per second
upload_total-
integer, total bytes uploaded so far
SEE ALSO
AUTHOR
Brandon Gilmore, <brandon@mg2.org>
COPYRIGHT AND LICENSE
Copyright (C) 2007 Brandon Gilmore
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.