diff --git a/docs/manual.html b/docs/manual.html index 75d98a1dc..67b85eb09 100644 --- a/docs/manual.html +++ b/docs/manual.html @@ -62,7 +62,7 @@
max_half_open_connections() returns the set limit. This limit defaults to 8 on windows.
-void load_asnum_db(char const* file); @@ -931,10 +931,9 @@ generated.@@ -4874,7 +4873,7 @@ public:get_ip_filter()
--
+- ::
-- ip_filter get_ip_filter() const;
-+ip_filter get_ip_filter() const; +Returns the ip_filter currently in the session. See ip_filter.
discover_device(), close() and rebind() are for internal uses and should not be called directly by clients.
-add_mapping
+add_mapping()
int add_mapping(protocol_type p, int external_port, int local_port); @@ -4896,14 +4895,14 @@ is -1, which means failure. There will not be any error alert notification for mappings that fail with a -1 return value.-delete_mapping
+delete_mapping()
void delete_mapping(int mapping_index);This function removes a port mapping. mapping_index is the index that refers -to the mapping you want to remove, which was returned from add_mapping.
+to the mapping you want to remove, which was returned from add_mapping().router_model()
@@ -5254,7 +5253,7 @@ case it appears the client is not running on a NAT:ed network or if it appears there is no NAT router that can be remote controlled to add port mappings.mapping refers to the mapping index of the port map that failed, i.e. -the index returned from add_mapping.
+the index returned from add_mapping().map_type is 0 for NAT-PMP and 1 for UPnP.
error tells you what failed.
@@ -5274,7 +5273,7 @@ a port was successfully mapped on it. On a NAT:ed network with a NAT-PMP capable router, this is typically generated once when mapping the TCP port and, if DHT is enabled, when the UDP port is mapped.mapping refers to the mapping index of the port map that failed, i.e. -the index returned from add_mapping.
+the index returned from add_mapping().external_port is the external port allocated for the mapping.
type is 0 for NAT-PMP and 1 for UPnP.
diff --git a/docs/manual.rst b/docs/manual.rst index 690d9b3ad..92eb13d38 100644 --- a/docs/manual.rst +++ b/docs/manual.rst @@ -651,8 +651,8 @@ their turn to get connected. ``max_half_open_connections()`` returns the set limit. This limit defaults to 8 on windows. -load_asnum_db() load_country_db() int as_for_ip() -------------------------------------------------- +load_asnum_db() load_country_db() as_for_ip() +--------------------------------------------- :: @@ -693,6 +693,7 @@ get_ip_filter() --------------- :: + ip_filter get_ip_filter() const; Returns the ip_filter currently in the session. See ip_filter_. @@ -5017,8 +5018,8 @@ for the DHT port (UDP). ``discover_device()``, ``close()`` and ``rebind()`` are for internal uses and should not be called directly by clients. -add_mapping ------------ +add_mapping() +------------- :: @@ -5042,15 +5043,15 @@ portmap_alert_ respectively. If The mapping fails immediately, the return value is -1, which means failure. There will not be any error alert notification for mappings that fail with a -1 return value. -delete_mapping --------------- +delete_mapping() +---------------- :: void delete_mapping(int mapping_index); This function removes a port mapping. ``mapping_index`` is the index that refers -to the mapping you want to remove, which was returned from add_mapping_. +to the mapping you want to remove, which was returned from `add_mapping()`_. router_model() -------------- @@ -5426,7 +5427,7 @@ appears there is no NAT router that can be remote controlled to add port mappings. ``mapping`` refers to the mapping index of the port map that failed, i.e. -the index returned from add_mapping_. +the index returned from `add_mapping()`_. ``map_type`` is 0 for NAT-PMP and 1 for UPnP. @@ -5450,7 +5451,7 @@ capable router, this is typically generated once when mapping the TCP port and, if DHT is enabled, when the UDP port is mapped. ``mapping`` refers to the mapping index of the port map that failed, i.e. -the index returned from add_mapping_. +the index returned from `add_mapping()`_. ``external_port`` is the external port allocated for the mapping.