rubytorrent 0.3

Sign up to get free protection for your applications and to get access to all the features.
data/COPYING ADDED
@@ -0,0 +1,340 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Library General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) <year> <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License
307
+ along with this program; if not, write to the Free Software
308
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
309
+
310
+
311
+ Also add information on how to contact you by electronic and paper mail.
312
+
313
+ If the program is interactive, make it output a short notice like this
314
+ when it starts in an interactive mode:
315
+
316
+ Gnomovision version 69, Copyright (C) year name of author
317
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
318
+ This is free software, and you are welcome to redistribute it
319
+ under certain conditions; type `show c' for details.
320
+
321
+ The hypothetical commands `show w' and `show c' should show the appropriate
322
+ parts of the General Public License. Of course, the commands you use may
323
+ be called something other than `show w' and `show c'; they could even be
324
+ mouse-clicks or menu items--whatever suits your program.
325
+
326
+ You should also get your employer (if you work as a programmer) or your
327
+ school, if any, to sign a "copyright disclaimer" for the program, if
328
+ necessary. Here is a sample; alter the names:
329
+
330
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
331
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
332
+
333
+ <signature of Ty Coon>, 1 April 1989
334
+ Ty Coon, President of Vice
335
+
336
+ This General Public License does not permit incorporating your program into
337
+ proprietary programs. If your program is a subroutine library, you may
338
+ consider it more useful to permit linking proprietary applications with the
339
+ library. If this is what you want to do, use the GNU Library General
340
+ Public License instead of this License.
data/README ADDED
@@ -0,0 +1,21 @@
1
+ Try it out
2
+ ----------
3
+
4
+ RubyTorrent is primarily a library. See doc/api.txt for an example of how to
5
+ use it in your Ruby applications. There are also a few executable scripts for
6
+ you to play around with.
7
+
8
+ rtpeer.rb: downloads a BitTorrent package.
9
+
10
+ rtpeer-ncurses.rb: a nicer, ncurses version of the same. (The standard Ruby
11
+ curses library appears not to play nicely with Threads, so we can't use it.)
12
+
13
+ dump-metainfo.rb: takes a .torrent metainfo file and spits out everything about
14
+ it.
15
+
16
+ make-metainfo.rb: creates a .torrent file.
17
+
18
+ dump-peers.rb: takes a .torrent metainfo file, connects to the tracker, and
19
+ displays all the peers. (hack.)
20
+
21
+ -- William <wmorgan-rubytorrent@masanjin.net>
@@ -0,0 +1,25 @@
1
+ Release notes for 0.3:
2
+
3
+ Many more bug fixes. Speed is now basically comparable to Bram's client---at
4
+ least in my limited experiments.
5
+
6
+ The following are known issues with this release:
7
+
8
+ - Ruby threads don't play well with curses. Non-blocking getch hangs.
9
+ See [ruby-talk:130620]. So we use ncurses.
10
+
11
+ - Ruby threads don't play well with TCP sockets on Windows. There is a
12
+ 20-second *global* freeze every time an outgoing connection is made to a
13
+ non-responsive host. See [ruby-talk:129578], [ruby-core:04364]. As you can
14
+ imagine, this can be quite a performance hit in a program that can make
15
+ potentially hundreds of such connections. In fact, it renders RubyTorrent
16
+ almost useless on Windows. A patch exists (indeed, has existed for many
17
+ months), and if I bug Matz maybe it'll get in to 1.8.3. :)
18
+
19
+ - Ruby threads don't play well with writing data over TCP sockets. At least,
20
+ that's what I glean from [ruby-talk:130480], and it might explain the
21
+ occasional freezing behavior I see (3 to 30 seconds, sporadic) under heavy
22
+ loads in Linux.
23
+
24
+ Other than that :) everything works. I think.
25
+
@@ -0,0 +1,289 @@
1
+ RubyTorrent Documentation
2
+
3
+ Introduction
4
+ ------------
5
+
6
+ RubyTorrent is a pure-Ruby BitTorrent library. You can use RubyTorrent
7
+ in your Ruby applications to download and serve files via the
8
+ BitTorrent protocol. More information about BitTorrent can be found
9
+ at http://bittorrent.com/.
10
+
11
+ There's a lot going behind the scenes, but using this library is
12
+ pretty simple: on the surface, RubyTorrent simply lets you download a
13
+ file or set of files, given an initial .torrent filename or URL.
14
+
15
+ I recommend you take a look at rtpeer.rb for an example Ruby BitTorrent
16
+ peer that uses all this stuff.
17
+
18
+ Synopsis
19
+ --------
20
+
21
+ require "rubytorrent"
22
+
23
+ # simple
24
+ bt = RubyTorrent::BitTorrent.new(filename)
25
+ bt.on_event(self, :complete) { puts "done!" }
26
+
27
+ # more complex
28
+ mi = RubyTorrent::MetaInfo.from_location(url)
29
+ package = RubyTorrent::Package.new(mi, dest)
30
+ bt = RubyTorrent::BitTorrent.new(mi, package)
31
+ thread = Thread.new do
32
+ until bt.complete?
33
+ puts "#{bt.percent_completed}% done"
34
+ sleep 5
35
+ end
36
+ end
37
+ bt.on_event(self, :complete) { puts "done!" }
38
+ thread.join
39
+
40
+ Overview
41
+ --------
42
+
43
+ There are three top-level classes you should be familiar with in the
44
+ RubyTorrent module: BitTorrent, MetaInfo and Package. BitTorrent is
45
+ the main interface; MetaInfo and Package classes allow you more
46
+ control over the details, but they're completely options and the
47
+ BitTorrent class will do reasonable things if you don't use them.
48
+
49
+ RubyTorrent has a very event-driven interface; all methods are
50
+ non-blocking and the BitTorrent class generates notifications of all
51
+ interesting events, which you can subscribe to. See the documentation
52
+ on BitTorrent#on_event() below for how to subscribe to events.
53
+
54
+ RubyTorrent::MetaInfo
55
+ ---------------------
56
+
57
+ This class represents the contents of the .torrent file or URL.
58
+
59
+ CLASS METHODS
60
+
61
+ from_location(location, http_proxy=ENV["http_proxy"])
62
+ Creates a MetaInfo object from a filename or URL.
63
+
64
+ Arguments:
65
+ location: a filename or a URL of a .torrent file.
66
+ http_proxy: is the HTTP proxy to be used in the case that
67
+ "location" is a URL (nil for none).
68
+
69
+ Returns:
70
+ A MetaInfo object.
71
+
72
+ Throws:
73
+ RubyTorrent::MetaInfoFormatError,
74
+ RubyTorrent::BEncodingError,
75
+ RubyTorrent::TypedStructError
76
+ if the contents of the file/url are not a BitTorrent metainfo file.
77
+ IOError, SystemCallError
78
+ if reading the contents of the file/url failed for system-level
79
+ issues.
80
+
81
+ from_stream(stream)
82
+ Creates a MetaInfo object from a readable IO stream.
83
+
84
+ Arguments:
85
+ stream: a readable IO stream, e.g. an opened File.
86
+
87
+ Returns:
88
+ A MetaInfo object.
89
+
90
+ Throws:
91
+ same as RubyTorrent::Metainfo#from_location
92
+
93
+ INSTANCE METHODS
94
+
95
+ single?
96
+ Returns true if this .torrent contains a single file, false otherwise.
97
+
98
+ multiple?
99
+ The opposite of single?
100
+
101
+ RubyTorrent::Package
102
+ --------------------
103
+
104
+ This class represents the target file or files on disk.
105
+
106
+ CLASS METHODS
107
+
108
+ new(info, out=nil, validity_assumption=nil, path_sep="/") # optional block
109
+ Creates a Package.
110
+
111
+ Arguments:
112
+ info: a MetaInfo object.
113
+ out: if info.single?, this should be a File object corresponding to
114
+ the target file on disk. If info.multiple?, this should be a Dir
115
+ object corresponding to the target directory on disk. If nil, the
116
+ original filename (for single-file .torrents) or the current
117
+ directory (for multi-file .torrents) will be used.
118
+ validity_assumption: if nil, make no assumptions about the validity of
119
+ any files on disk. If true, assume all files on disk are complete
120
+ and valid. If false, assume all files on disk are incomplete and
121
+ invalid. This can be used to speed up start time by skipping all
122
+ examination of current disk contents: if you're just starting a
123
+ download, you can use false; if you're serving a complete file or
124
+ set of files, you can use true.
125
+ path_sep: how to join path-name components to make paths. "/"
126
+ should work on both Windows and Unix worlds; I'm not sure about
127
+ other OSs.
128
+
129
+ Block:
130
+ If given, yields a "Piece" object when checking the files on
131
+ disk. This object has complete?() and valid?() methods. This is
132
+ really only useful for updating the user on the status of the
133
+ Package creation, which can take a long time for large files (I/O
134
+ time and SHA1 calculations).
135
+
136
+ Throws:
137
+ IOError, if the file access fails.
138
+
139
+ RubyTorrent::BitTorrent
140
+ -----------------------
141
+
142
+ The main BitTorrent peer protocol interface.
143
+
144
+ CLASS METHODS
145
+
146
+ new(metainfo, package=nil, :host, :port, :dlratelim, :ulratelim, :http_proxy)
147
+ Creates a BitTorrent peer.
148
+
149
+ Arguments (all symbol arguments are optional hash pseudo-keyword arguments):
150
+ metainfo: a String, IO or MetaInfo object corresponding to a .torrent file.
151
+ In the case of a String or IO object, a MetaInfo object will be implictly
152
+ created with default arguments.
153
+ package: a Package, or nil. In the case on nil, a new Package will be
154
+ implicitly created with default arguments.
155
+ :host: the host to report to the tracker, if the source IP address of the
156
+ HTTP request is not correct (for weird IP masquerading issues, I suppose).
157
+ :port: the port to report to the tracker, if the port the BitTorrent peer is
158
+ listening on is not correct (likewise).
159
+ :dlratelim: the download rate limit in bytes/sec. This limit right now is
160
+ applied on a per-peer basis to the average download rate. In the future
161
+ this might change to something stricter/more useful.
162
+ :ulratelim: likewise, for the upload rate limit.
163
+ :http_proxy: the http_proxy used for connecting to the tracker, or nil
164
+ or unspecified for ENV["http_proxy"].
165
+
166
+ Throws:
167
+ All of the exceptions thrown by MetaInfo.new and Package.new.
168
+
169
+ INSTANCE METHODS
170
+
171
+ running?
172
+ Returns whether this client is running or not.
173
+
174
+ ip
175
+ Returns the IP address the client is bound to, as a String (possibly "0.0.0.0")
176
+
177
+ port
178
+ Returns the port the client is bound to.
179
+
180
+ complete?
181
+ Returns whether the file on disk is complete or not.
182
+
183
+ bytes_completed
184
+ Returns the number of bytes completed.
185
+
186
+ total_bytes
187
+ Returns the total number of bytes in the target file/fileset.
188
+
189
+ percent_completed
190
+ Returns the percent of bytes completed.
191
+
192
+ pieces_completed
193
+ Returns the number of BitTorrent "pieces" completed.
194
+
195
+ num_pieces
196
+ Returns the total number of BitTorrent pieces.
197
+
198
+ tracker
199
+ Returns the URL of the tracker being used, or nil if no tracker can be reached.
200
+
201
+ num_possible_peers
202
+ Returns the number of peers we've read from the tracker, or nil if no tracker
203
+ can be reached. This is typically capped at 50.
204
+
205
+ peer_info
206
+ Returns an array of hashes, one per current peer, with the following symbols
207
+ as keys:
208
+ :name: the peer name (probably "ip address/port")
209
+ :seed: true if the peer is a seed, false if it's a leecher
210
+ :dlamt, :ulamt: the number of bytes downloaded from /uploaded to this peer
211
+ :dlrate, :ulrate: the bytes/sec downloaded from/uploaded to this peer
212
+ :pending_send, :pending_recv: the number of blocks pending for send/receive
213
+ :interested, :peer_interested: who's interested in the other's pieces
214
+ :choking, :peer_choking: who's choking whom
215
+ :snubbing: whether we're snubbing this peer
216
+ :we_desire, :they_desire: number of pieces one has that the other wants
217
+ A lot of this stuff has to do with the internals of the BitTorrent wire
218
+ protocol, so it's mainly useful for debugging.
219
+
220
+ shutdown
221
+ Shuts down this particular client.
222
+
223
+ shutdown_all
224
+ Shuts down all clients.
225
+
226
+ on_event(who, *events) # mandatory block
227
+ Registers a notification for one or more events. When one of the
228
+ events occurs, the block will be called. The first argument to the
229
+ block will be the source of the event (in this case a
230
+ RubyTorrent::BitTorrent object); the other arguments are dependent
231
+ on the block itself.
232
+
233
+ Arguments:
234
+ who: should be "self"
235
+ events: one or more event symbols (see EVENTS below)
236
+
237
+ unregister_events(who, *events)
238
+ Unregisters event notifications. All blocks added with on_event(who, ...)
239
+ will be removed if they have an event in "events". If "events" is nil,
240
+ all blocks registered with on_event(who, ...) will be removed.
241
+
242
+ Arguments:
243
+ who: the same argument as was passed to on_event()
244
+ events: one or more event symbols.
245
+
246
+ EVENTS
247
+
248
+ :trying_peer |source, peer|
249
+ We're trying to connect to the peer "peer" (a String: "ip addr/port").
250
+
251
+ :forgetting_peer |source, peer|
252
+ We're couldn't connect to the peer.
253
+
254
+ :added_peer |source, peer|
255
+ We successfully connected to the peer.
256
+
257
+ :removed_peer |source, peer|
258
+ We dropped our connection to the peer.
259
+
260
+ :received_block |source, block, peer|
261
+ We received a block "block" from peer.
262
+
263
+ :sent_block |source, block, peer|
264
+ We sent a block "block" to peer.
265
+
266
+ :have_piece |source, piece|
267
+ We've successfully downloaded a complete piece "piece".
268
+
269
+ :discarded_piece |source, piece|
270
+ We had to discard piece "piece" because of checksum errors
271
+
272
+ :complete |source|
273
+ We've downloaded the entire file! Hooray!
274
+
275
+ :tracker_connected |source, url|
276
+ We connected to tracker "url".
277
+
278
+ :tracker_lost
279
+ We couldn't connect to tracker "url" after previously having connected to it.
280
+
281
+ COPYRIGHT
282
+ ---------
283
+
284
+ Copyright 2005 William Morgan
285
+ Permission is granted to copy, distribute and/or modify this document under the
286
+ terms of the GNU Free Documentation License, Version 1.2; with no Invariant
287
+ Sections, no Front-Cover Texts, and no Back-Covers. A copy of the license may
288
+ be found at http://www.gnu.org/licenses/fdl.html.
289
+