Network.RTorrent.CommandList

A module for defined commands.

To combine multiple commands, use :*:, or store them in a list, as both of these types have Command instances.

Documentation

module Network.RTorrent.File

module Network.RTorrent.Peer

module Network.RTorrent.Priority

module Network.RTorrent.Torrent

module Network.RTorrent.Tracker

Functions for global variables

data Global t

Execute a command with a result type t.

Instances

Functor Global

Command (Global a)

type Ret (Global a) = a

getUpRate :: Global Int

Get the current up rate, in bytes per second.

getDownRate :: Global Int

Get the current down rate, in bytes per second.

getDirectory :: Global String

Get the default download directory.

getPid :: Global Int

Get the process id.

getUploadRate :: Global Int

Get the maximum upload rate, in bytes per second.

0 means no limit.

getDownloadRate :: Global Int

Get the maximum download rate, in bytes per second.

0 means no limit.

setUploadRate :: Int -> Global Int

Set the maximum upload rate, in bytes per second.

setDownloadRate :: Int -> Global Int

Set the maximum download rate, in bytes per second.

Loading new torrents

loadTorrent

Arguments

:: String

A path / URL

-> Global Int

Load a torrent file.

loadTorrentRaw

Arguments

:: ByteString

A torrent file as data

-> Global Int

Load a torrent file.

loadStartTorrent

Arguments

:: String

A path / URL

-> Global Int

Load a torrent file and start downloading it.

loadStartTorrentRaw

Arguments

:: ByteString

A torrent file as data

-> Global Int

Load a torrent file and start downloading it.

Constructing new commands

commandSimple :: XmlRpcType a => String -> Global a

Run a command with no arguments.

commandArgs :: XmlRpcType a => String -> [Value] -> Global a

Run a command with the given arguments.

commandInt :: XmlRpcType a => String -> Int -> Global a

Run a command with the Int given as an argument.

commandString

Arguments

:: XmlRpcType a

=> String

Command

-> String

Argument

-> Global a

Run a command with the String given as an argument.

Re-exported from Network.RTorrent.Action

(<+>) :: (i -> Action i a) -> (i -> Action i b) -> i -> Action i (a :*: b) infixr 6

Combine two actions to get a new one.

sequenceActions :: Traversable f => f (i -> Action i a) -> i -> Action i (f a)

Sequence multiple actions, for example with f = [].

Re-exported from Network.RTorrent.Command

data a :*: b infixr 6

A strict 2-tuple for easy combining of commands.

Constructors

(:*:) !a !b infixr 6

Instances

(Show a, Show b) => Show ((:*:) a b)

(NFData a, NFData b) => NFData ((:*:) a b)

(Command a, Command b) => Command ((:*:) a b)

type Ret ((:*:) a b) = (:*:) (Ret a) (Ret b)

data AnyCommand where

Existential wrapper for any command.

Commands wrapped in AnyCommand won't parse their results.

AnyCommand can be used when you want to call multiple commands but don't care about their return values.

Constructors

AnyCommand :: Command a => a -> AnyCommand

Instances

Command AnyCommand

type Ret AnyCommand = Value

class Command a

A typeclass for commands that can be send to RTorrent.

Minimal complete definition

commandCall, commandValue

Associated Types

type Ret a

Return type of the command.

Instances

Command AnyCommand

Command a => Command [a]

Command (Global a)

(Command a, Command b) => Command ((:*:) a b)

Command (AllAction i a)

XmlRpcType i => Command (Action i a)