rubytorrent 0.3

data/COPYING

@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                       59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/README

@@ -0,0 +1,21 @@
+Try it out
+----------
+
+RubyTorrent is primarily a library. See doc/api.txt for an example of how to
+use it in your Ruby applications. There are also a few executable scripts for
+you to play around with.
+
+rtpeer.rb: downloads a BitTorrent package.
+
+rtpeer-ncurses.rb: a nicer, ncurses version of the same. (The standard Ruby
+curses library appears not to play nicely with Threads, so we can't use it.)
+
+dump-metainfo.rb: takes a .torrent metainfo file and spits out everything about
+it.
+
+make-metainfo.rb: creates a .torrent file.
+
+dump-peers.rb: takes a .torrent metainfo file, connects to the tracker, and
+displays all the peers. (hack.)
+
+-- William <wmorgan-rubytorrent@masanjin.net>

data/ReleaseNotes.txt

@@ -0,0 +1,25 @@
+Release notes for 0.3:
+
+Many more bug fixes. Speed is now basically comparable to Bram's client---at
+least in my limited experiments. 
+
+The following are known issues with this release:
+
+- Ruby threads don't play well with curses. Non-blocking getch hangs.
+  See [ruby-talk:130620]. So we use ncurses.
+
+- Ruby threads don't play well with TCP sockets on Windows. There is a
+  20-second *global* freeze every time an outgoing connection is made to a
+  non-responsive host. See [ruby-talk:129578], [ruby-core:04364]. As you can
+  imagine, this can be quite a performance hit in a program that can make
+  potentially hundreds of such connections. In fact, it renders RubyTorrent
+  almost useless on Windows. A patch exists (indeed, has existed for many
+  months), and if I bug Matz maybe it'll get in to 1.8.3. :)
+
+- Ruby threads don't play well with writing data over TCP sockets. At least,
+  that's what I glean from [ruby-talk:130480], and it might explain the
+  occasional freezing behavior I see (3 to 30 seconds, sporadic) under heavy
+  loads in Linux.
+
+Other than that :) everything works. I think.
+

data/doc/api.txt

@@ -0,0 +1,289 @@
+RubyTorrent Documentation
+
+Introduction
+------------
+
+RubyTorrent is a pure-Ruby BitTorrent library. You can use RubyTorrent
+in your Ruby applications to download and serve files via the
+BitTorrent protocol.  More information about BitTorrent can be found
+at http://bittorrent.com/.
+
+There's a lot going behind the scenes, but using this library is
+pretty simple: on the surface, RubyTorrent simply lets you download a
+file or set of files, given an initial .torrent filename or URL.
+
+I recommend you take a look at rtpeer.rb for an example Ruby BitTorrent
+peer that uses all this stuff.
+
+Synopsis
+--------
+
+require "rubytorrent"
+
+# simple
+bt = RubyTorrent::BitTorrent.new(filename)
+bt.on_event(self, :complete) { puts "done!" }
+
+# more complex
+mi = RubyTorrent::MetaInfo.from_location(url)
+package = RubyTorrent::Package.new(mi, dest)
+bt = RubyTorrent::BitTorrent.new(mi, package)
+thread = Thread.new do
+  until bt.complete?
+    puts "#{bt.percent_completed}% done"
+    sleep 5
+  end
+end
+bt.on_event(self, :complete) { puts "done!" }
+thread.join
+
+Overview
+--------
+
+There are three top-level classes you should be familiar with in the
+RubyTorrent module: BitTorrent, MetaInfo and Package. BitTorrent is
+the main interface; MetaInfo and Package classes allow you more
+control over the details, but they're completely options and the
+BitTorrent class will do reasonable things if you don't use them.
+
+RubyTorrent has a very event-driven interface; all methods are
+non-blocking and the BitTorrent class generates notifications of all
+interesting events, which you can subscribe to. See the documentation
+on BitTorrent#on_event() below for how to subscribe to events.
+
+RubyTorrent::MetaInfo
+---------------------
+
+This class represents the contents of the .torrent file or URL.
+
+CLASS METHODS
+
+from_location(location, http_proxy=ENV["http_proxy"])
+  Creates a MetaInfo object from a filename or URL.
+
+  Arguments:
+   location: a filename or a URL of a .torrent file.
+   http_proxy: is the HTTP proxy to be used in the case that
+    "location" is a URL (nil for none).
+
+  Returns:
+    A MetaInfo object.
+
+  Throws:
+    RubyTorrent::MetaInfoFormatError,
+    RubyTorrent::BEncodingError,
+    RubyTorrent::TypedStructError
+      if the contents of the file/url are not a BitTorrent metainfo file.
+    IOError, SystemCallError
+      if reading the contents of the file/url failed for system-level
+      issues.
+
+from_stream(stream)
+  Creates a MetaInfo object from a readable IO stream.
+
+  Arguments:
+    stream: a readable IO stream, e.g. an opened File.
+
+  Returns:
+    A MetaInfo object.
+
+  Throws:
+    same as RubyTorrent::Metainfo#from_location
+
+INSTANCE METHODS
+
+single?
+  Returns true if this .torrent contains a single file, false otherwise.
+
+multiple?
+  The opposite of single?
+
+RubyTorrent::Package
+--------------------
+
+This class represents the target file or files on disk.
+
+CLASS METHODS
+
+new(info, out=nil, validity_assumption=nil, path_sep="/") # optional block
+  Creates a Package.
+
+  Arguments:
+   info: a MetaInfo object.
+   out: if info.single?, this should be a File object corresponding to
+     the target file on disk. If info.multiple?, this should be a Dir
+     object corresponding to the target directory on disk. If nil, the
+     original filename (for single-file .torrents) or the current
+     directory (for multi-file .torrents) will be used.
+   validity_assumption: if nil, make no assumptions about the validity of
+     any files on disk. If true, assume all files on disk are complete
+     and valid. If false, assume all files on disk are incomplete and
+     invalid.  This can be used to speed up start time by skipping all
+     examination of current disk contents: if you're just starting a
+     download, you can use false; if you're serving a complete file or
+     set of files, you can use true.
+   path_sep: how to join path-name components to make paths. "/"
+     should work on both Windows and Unix worlds; I'm not sure about
+     other OSs.
+
+  Block:
+    If given, yields a "Piece" object when checking the files on
+    disk. This object has complete?() and valid?() methods. This is
+    really only useful for updating the user on the status of the
+    Package creation, which can take a long time for large files (I/O
+    time and SHA1 calculations).
+
+  Throws:
+    IOError, if the file access fails.
+
+RubyTorrent::BitTorrent
+-----------------------
+
+The main BitTorrent peer protocol interface.
+
+CLASS METHODS
+
+new(metainfo, package=nil, :host, :port, :dlratelim, :ulratelim, :http_proxy)
+  Creates a BitTorrent peer.
+
+  Arguments (all symbol arguments are optional hash pseudo-keyword arguments):
+    metainfo: a String, IO or MetaInfo object corresponding to a .torrent file.
+      In the case of a String or IO object, a MetaInfo object will be implictly
+      created with default arguments.
+    package: a Package, or nil. In the case on nil, a new Package will be
+      implicitly created with default arguments.
+    :host: the host to report to the tracker, if the source IP address of the
+      HTTP request is not correct (for weird IP masquerading issues, I suppose).
+    :port: the port to report to the tracker, if the port the BitTorrent peer is
+      listening on is not correct (likewise).
+    :dlratelim: the download rate limit in bytes/sec. This limit right now is
+      applied on a per-peer basis to the average download rate. In the future
+      this might change to something stricter/more useful.
+    :ulratelim: likewise, for the upload rate limit.
+    :http_proxy: the http_proxy used for connecting to the tracker, or nil
+      or unspecified for ENV["http_proxy"].
+
+  Throws:
+    All of the exceptions thrown by MetaInfo.new and Package.new.
+
+INSTANCE METHODS
+
+running?
+  Returns whether this client is running or not.
+
+ip
+  Returns the IP address the client is bound to, as a String (possibly "0.0.0.0")
+
+port
+  Returns the port the client is bound to.
+
+complete?
+  Returns whether the file on disk is complete or not.
+
+bytes_completed
+  Returns the number of bytes completed.
+
+total_bytes
+  Returns the total number of bytes in the target file/fileset.
+  
+percent_completed
+  Returns the percent of bytes completed.
+
+pieces_completed
+  Returns the number of BitTorrent "pieces" completed.
+
+num_pieces
+  Returns the total number of BitTorrent pieces.
+
+tracker
+  Returns the URL of the tracker being used, or nil if no tracker can be reached.
+
+num_possible_peers
+  Returns the number of peers we've read from the tracker, or nil if no tracker
+  can be reached. This is typically capped at 50.
+
+peer_info
+  Returns an array of hashes, one per current peer, with the following symbols
+  as keys:
+    :name: the peer name (probably "ip address/port")
+    :seed: true if the peer is a seed, false if it's a leecher
+    :dlamt, :ulamt: the number of bytes downloaded from /uploaded to this peer
+    :dlrate, :ulrate: the bytes/sec downloaded from/uploaded to this peer
+    :pending_send, :pending_recv: the number of blocks pending for send/receive
+    :interested, :peer_interested: who's interested in the other's pieces
+    :choking, :peer_choking: who's choking whom
+    :snubbing: whether we're snubbing this peer
+    :we_desire, :they_desire: number of pieces one has that the other wants
+  A lot of this stuff has to do with the internals of the BitTorrent wire
+  protocol, so it's mainly useful for debugging.
+
+shutdown
+  Shuts down this particular client.
+
+shutdown_all
+  Shuts down all clients.
+
+on_event(who, *events) # mandatory block
+  Registers a notification for one or more events. When one of the
+  events occurs, the block will be called. The first argument to the
+  block will be the source of the event (in this case a
+  RubyTorrent::BitTorrent object); the other arguments are dependent
+  on the block itself.
+
+  Arguments:
+    who: should be "self"
+    events: one or more event symbols (see EVENTS below)
+
+unregister_events(who, *events)
+  Unregisters event notifications. All blocks added with on_event(who, ...)
+  will be removed if they have an event in "events". If "events" is nil,
+  all blocks registered with on_event(who, ...) will be removed.
+
+  Arguments:
+    who: the same argument as was passed to on_event()
+    events: one or more event symbols.
+
+EVENTS
+
+:trying_peer |source, peer|
+  We're trying to connect to the peer "peer" (a String: "ip addr/port").
+
+:forgetting_peer |source, peer|
+  We're couldn't connect to the peer.
+ 
+:added_peer |source, peer|
+  We successfully connected to the peer.
+
+:removed_peer |source, peer|
+  We dropped our connection to the peer.
+
+:received_block |source, block, peer|
+  We received a block "block" from peer.
+
+:sent_block |source, block, peer|
+  We sent a block "block" to peer.
+
+:have_piece |source, piece|
+  We've successfully downloaded a complete piece "piece".
+
+:discarded_piece |source, piece|
+  We had to discard piece "piece" because of checksum errors
+
+:complete |source|
+  We've downloaded the entire file! Hooray!
+
+:tracker_connected |source, url|
+  We connected to tracker "url".
+
+:tracker_lost
+  We couldn't connect to tracker "url" after previously having connected to it.
+
+COPYRIGHT
+---------
+
+Copyright 2005 William Morgan
+Permission is granted to copy, distribute and/or modify this document under the
+terms of the GNU Free Documentation License, Version 1.2; with no Invariant
+Sections, no Front-Cover Texts, and no Back-Covers. A copy of the license may
+be found at http://www.gnu.org/licenses/fdl.html.
+