revamped part of the port mapping code (UPnP and NAT-PMP). Added documentation for start_{lsd,natpmp,upnp} and stop_{lsd,natpmp,upnp}

This commit is contained in:
Arvid Norberg
2008-04-06 19:17:58 +00:00
parent 35fd9aec61
commit 2e6b9c2dce
13 changed files with 720 additions and 333 deletions

View File

@@ -161,6 +161,15 @@ The ``session`` class has the following synopsis::
, int> const& node);
void add_dht_router(std::pair<std::string
, int> const& node);
void start_lsd();
void stop_lsd();
boost::intrusive_ptr<upnp> start_upnp();
void stop_upnp();
boost::intrusvice_ptr<natpmp> start_natpmp();
void stop_natpmp();
};
Once it's created, the session object will spawn the main thread that will do all the work.
@@ -855,6 +864,47 @@ An example routing node that you could typically add is
``router.bittorrent.com``.
start_lsd() stop_lsd()
----------------------
::
void start_lsd();
void stop_lsd();
Starts and stops Local Service Discovery. This service will broadcast
the infohashes of all the non-private torrents on the local network to
look for peers on the same swarm within multicast reach.
It is turned off by default.
start_upnp() stop_upnp()
------------------------
::
boost::intrusive_ptr<upnp> start_upnp();
void stop_upnp();
Starts and stops the UPnP service. When started, the listen port and the DHT
port are attempted to be forwarded on local UPnP router devices.
It is off by default.
start_natpmp() stop_natpmp()
----------------------------
::
boost::intrusvice_ptr<natpmp> start_natpmp();
void stop_natpmp();
Starts and stops the NAT-PMP service. When started, the listen port and the DHT
port are attempted to be forwarded on the router through NAT-PMP.
It is off by default.
entry
=====