Class: Transmission::RPC

Inherits:
Object
  • Object
show all
Defined in:
lib/transmission/rpc.rb,
lib/transmission/rpc/connector.rb

Defined Under Namespace

Classes: Connector

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ RPC

Returns a new instance of RPC.



7
8
9
 
# File 'lib/transmission/rpc.rb', line 7

def initialize(options = {})
  @connector = Connector.new options
end

Instance Attribute Details

#connector ⇒ Object

Returns the value of attribute connector.



5
6
7
 
# File 'lib/transmission/rpc.rb', line 5

def connector
  @connector
end

#session ⇒ Object

Returns the value of attribute session.



5
6
7
 
# File 'lib/transmission/rpc.rb', line 5

def session
  @session
end

Instance Method Details

#add_torrent(arguments) ⇒ Object 



57
58
59
60
 
# File 'lib/transmission/rpc.rb', line 57

def add_torrent(arguments)
  arguments = Transmission::Arguments::TorrentAdd.new(arguments)
  @connector.post method: 'torrent-add', arguments: arguments.to_arguments
end

#blocklist ⇒ Object 



31
32
33
 
# File 'lib/transmission/rpc.rb', line 31

def blocklist
  @connector.post method: 'blocklist-update'
end

#close_session ⇒ Object 



23
24
25
 
# File 'lib/transmission/rpc.rb', line 23

def close_session
  @connector.post method: 'session-close'
end

#free_space ⇒ Object 



35
36
37
 
# File 'lib/transmission/rpc.rb', line 35

def free_space
  @connector.post method: 'free-space'
end

#get_session(fields = nil) ⇒ Object 



11
12
13
14
15
 
# File 'lib/transmission/rpc.rb', line 11

def get_session(fields = nil)
  fields = Transmission::Fields::SessionGet.new(fields)
  arguments = { fields: fields.to_fields }
  @connector.post method: 'session-get', arguments: arguments
end

#get_session_stats(fields = nil) ⇒ Object 



17
18
19
20
21
 
# File 'lib/transmission/rpc.rb', line 17

def get_session_stats(fields = nil)
  fields = Transmission::Fields::SessionStats.new(fields)
  arguments = { fields: fields.to_fields }
  @connector.post method: 'session-stats', arguments: arguments
end

#get_torrent(ids, fields = nil) ⇒ Object 



39
40
41
42
43
44
 
# File 'lib/transmission/rpc.rb', line 39

def get_torrent(ids, fields = nil)
  fields = Transmission::Fields::TorrentGet.new(fields)
  arguments = { fields: fields.to_fields }
  arguments[:ids] = ids if ids.is_a? Array
  @connector.post method: 'torrent-get', arguments: arguments
end

#move_bottom_torrent(ids) ⇒ Object 



104
105
106
 
# File 'lib/transmission/rpc.rb', line 104

def move_bottom_torrent(ids)
  @connector.post method: 'queue-move-bottom', arguments: id_arguments(ids)
end

#move_down_torrent(ids) ⇒ Object 



96
97
98
 
# File 'lib/transmission/rpc.rb', line 96

def move_down_torrent(ids)
  @connector.post method: 'queue-move-down', arguments: id_arguments(ids)
end

#move_top_torrent(ids) ⇒ Object 



100
101
102
 
# File 'lib/transmission/rpc.rb', line 100

def move_top_torrent(ids)
  @connector.post method: 'queue-move-top', arguments: id_arguments(ids)
end

#move_up_torrent(ids) ⇒ Object 



92
93
94
 
# File 'lib/transmission/rpc.rb', line 92

def move_up_torrent(ids)
  @connector.post method: 'queue-move-up', arguments: id_arguments(ids)
end

#re_announce_torrent(ids) ⇒ Object 



88
89
90
 
# File 'lib/transmission/rpc.rb', line 88

def re_announce_torrent(ids)
  @connector.post method: 'torrent-reannounce', arguments: id_arguments(ids)
end

#remove_torrent(ids, delete_local_data = false) ⇒ Object 



68
69
70
 
# File 'lib/transmission/rpc.rb', line 68

def remove_torrent(ids, delete_local_data = false)
  @connector.post method: 'torrent-remove', arguments: { ids: ids, 'delete-local-data' => delete_local_data }
end

#set_session(arguments) ⇒ Object 



52
53
54
55
 
# File 'lib/transmission/rpc.rb', line 52

def set_session(arguments)
  arguments = Transmission::Arguments::SessionSet.new(arguments)
  @connector.post method: 'session-set', arguments: arguments.to_arguments
end

#set_torrent(ids, arguments) ⇒ Object 



46
47
48
49
50
 
# File 'lib/transmission/rpc.rb', line 46

def set_torrent(ids, arguments)
  arguments[:ids] = ids
  arguments = Transmission::Arguments::TorrentSet.new(arguments)
  @connector.post method: 'torrent-set', arguments: arguments.to_arguments
end

#start_torrent(ids) ⇒ Object 



72
73
74
 
# File 'lib/transmission/rpc.rb', line 72

def start_torrent(ids)
  @connector.post method: 'torrent-start', arguments: id_arguments(ids)
end

#start_torrent_now(ids) ⇒ Object 



76
77
78
 
# File 'lib/transmission/rpc.rb', line 76

def start_torrent_now(ids)
  @connector.post method: 'torrent-start-now', arguments: id_arguments(ids)
end

#stop_torrent(ids) ⇒ Object 



80
81
82
 
# File 'lib/transmission/rpc.rb', line 80

def stop_torrent(ids)
  @connector.post method: 'torrent-stop', arguments: id_arguments(ids)
end

#test_port ⇒ Object 



27
28
29
 
# File 'lib/transmission/rpc.rb', line 27

def test_port
  @connector.post method: 'port-test'
end

#torrent_set_location(ids, arguments) ⇒ Object 



62
63
64
65
66
 
# File 'lib/transmission/rpc.rb', line 62

def torrent_set_location(ids, arguments)
  arguments[:ids] = ids
  arguments = Transmission::Arguments::LocationSet.new(arguments)
  @connector.post method: 'torrent-set-location', arguments: arguments.to_arguments
end

#verify_torrent(ids) ⇒ Object 



84
85
86
 
# File 'lib/transmission/rpc.rb', line 84

def verify_torrent(ids)
  @connector.post method: 'torrent-verify', arguments: id_arguments(ids)
end