Copyright	(c) Kai Lindholm, 2014
License	MIT
Maintainer	megantti@gmail.com
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Network.RTorrent.Torrent

Contents

Functions for handling torrents
Functions for single variables

Description

For more info on actions, see Network.RTorrent.Action.

Synopsis

Documentation

data TorrentInfo Source

Constructors

TorrentInfo
Fields torrentId :: TorrentId torrentName :: String torrentOpen :: !Bool torrentDownRate :: !Int torrentUpRate :: !Int torrentSize :: !Int torrentBytesLeft :: !Int torrentPath :: String torrentDir :: String torrentTorrentPriority :: !TorrentPriority

Instances

Show TorrentInfo
NFData TorrentInfo

newtype TorrentId Source

A newtype wrapper for torrent identifiers.

Constructors

TorrentId String

Instances

Show TorrentId
NFData TorrentId
XmlRpcType TorrentId

type TorrentAction = Action TorrentId Source

Functions for handling torrents

start :: TorrentId -> TorrentAction Int Source

Start downloading a torrent.

close :: TorrentId -> TorrentAction Int Source

Close a torrent.

stop :: TorrentId -> TorrentAction Int Source

Stop a torrent.

closeStop :: TorrentId -> TorrentAction Int Source

erase :: TorrentId -> TorrentAction Int Source

Erase a torrent.

checkHash :: TorrentId -> TorrentAction Int Source

Initiate a hash check for a torrent.

getTorrent :: TorrentId -> TorrentAction TorrentInfo Source

Get a TorrentInfo for a torrent.

getTorrents :: AllAction TorrentId TorrentInfo Source

A command for getting torrent info for all torrents.

allTorrents :: (TorrentId -> TorrentAction a) -> AllAction TorrentId a Source

Execute a command on all torrents. For example the command

allTorrents (setTorrentPriority TorrentPriorityNormal)

will set the priority of all torrents to normal.

Functions for single variables

setTorrentPriority :: TorrentPriority -> TorrentId -> TorrentAction Int Source

Set the download priority of a torrent.

getTorrentPriority :: TorrentId -> TorrentAction TorrentPriority Source

getTorrentId :: TorrentId -> TorrentAction TorrentId Source

getTorrentOpen :: TorrentId -> TorrentAction Bool Source

getTorrentUpRate :: TorrentId -> TorrentAction Int Source

getTorrentDownRate :: TorrentId -> TorrentAction Int Source

getTorrentSizeBytes :: TorrentId -> TorrentAction Int Source

getTorrentLeftBytes :: TorrentId -> TorrentAction Int Source

getTorrentName :: TorrentId -> TorrentAction String Source

getTorrentPath :: TorrentId -> TorrentAction String Source

Get the absolute path to the torrent's directory or file.

getTorrentDir :: TorrentId -> TorrentAction String Source

Get the absolute path to the directory in which the torrent's directory or file resides.

setTorrentDir :: String -> TorrentId -> TorrentAction Int Source

getTorrentRatio :: TorrentId -> TorrentAction Int Source

Get the ratio (which is multiplied by a thousand)

getTorrentFileCount :: TorrentId -> TorrentAction Int Source