include/libtorrent/magnet_uri.hpp

   1 /*
   2
   3 Copyright (c) 2007, Arvid Norberg
   4 All rights reserved.
   5
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions
   8 are met:
   9
  10     * Redistributions of source code must retain the above copyright
  11       notice, this list of conditions and the following disclaimer.
  12     * Redistributions in binary form must reproduce the above copyright
  13       notice, this list of conditions and the following disclaimer in
  14       the documentation and/or other materials provided with the distribution.
  15     * Neither the name of the author nor the names of its
  16       contributors may be used to endorse or promote products derived
  17       from this software without specific prior written permission.
  18
  19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  23 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29 POSSIBILITY OF SUCH DAMAGE.
  30
  31 */
  32
  33 #ifndef TORRENT_MAGNET_URI_HPP_INCLUDED
  34 #define TORRENT_MAGNET_URI_HPP_INCLUDED
  35
  36 #include <string>
  37 #include "libtorrent/config.hpp"
  38 #include "libtorrent/torrent_handle.hpp"
  39 #include "libtorrent/session.hpp"
  40 #include <boost/filesystem/path.hpp>
  41
  42 namespace libtorrent
  43 {
  44         namespace fs = boost::filesystem;
  45
  46         struct torrent_handle;
  47
  48         std::string TORRENT_EXPORT make_magnet_uri(torrent_handle const& handle);
  49
  50 #ifndef TORRENT_NO_DEPRECATE
  51         // deprecated in 0.14
  52         torrent_handle TORRENT_EXPORT add_magnet_uri(session& ses, std::string const& uri
  53                 , fs::path const& save_path
  54                 , storage_mode_t storage_mode = storage_mode_sparse
  55                 , bool paused = false
  56                 , storage_constructor_type sc = default_storage_constructor
  57                 , void* userdata = 0) TORRENT_DEPRECATED;
  58 #endif
  59
  60         torrent_handle TORRENT_EXPORT add_magnet_uri(session& ses, std::string const& uri
  61                 , add_torrent_params p);
  62 }
  63
  64 #endif
  65