use a strong typedef for port mapping id

Author: arvidn

include/libtorrent/alert_types.hpp

@@ -1401,7 +1401,7 @@ namespace libtorrent {
 	struct TORRENT_EXPORT portmap_error_alert final : alert
 	{
 		// internal
-		portmap_error_alert(aux::stack_allocator& alloc, int i
+		portmap_error_alert(aux::stack_allocator& alloc, port_mapping_t i
 			, portmap_transport t
 			, error_code const& e);
 
@@ -1413,7 +1413,7 @@ namespace libtorrent {
 
 		// refers to the mapping index of the port map that failed, i.e.
 		// the index returned from add_mapping().
-		int const mapping;
+		port_mapping_t const mapping;
 
 		// UPnP or NAT-PMP
 		portmap_transport map_transport;
@@ -1435,7 +1435,7 @@ namespace libtorrent {
 	struct TORRENT_EXPORT portmap_alert final : alert
 	{
 		// internal
-		portmap_alert(aux::stack_allocator& alloc, int i, int port
+		portmap_alert(aux::stack_allocator& alloc, port_mapping_t i, int port
 			, portmap_transport t, portmap_protocol protocol);
 
 		TORRENT_DEFINE_ALERT(portmap_alert, 51)
@@ -1445,7 +1445,7 @@ namespace libtorrent {
 
 		// refers to the mapping index of the port map that failed, i.e.
 		// the index returned from add_mapping().
-		int const mapping;
+		port_mapping_t const mapping;
 
 		// the external port allocated for the mapping.
 		int const external_port;

include/libtorrent/aux_/portmap.hpp

@@ -52,7 +52,7 @@ namespace aux {
 		// int: protocol (UDP, TCP)
 		// error_code: error, an empty error means success
 		// int: transport is 0 for NAT-PMP and 1 for UPnP
-		virtual void on_port_mapping(int mapping, address const& ip, int port
+		virtual void on_port_mapping(port_mapping_t mapping, address const& ip, int port
 			, portmap_protocol proto, error_code const& ec, portmap_transport transport) = 0;
 #ifndef TORRENT_DISABLE_LOGGING
 		virtual bool should_log_portmap(portmap_transport transport) const = 0;

include/libtorrent/aux_/session_impl.hpp

@@ -137,10 +137,10 @@ namespace aux {
 	{
 		listen_socket_t()
 		{
-			tcp_port_mapping[0] = -1;
-			tcp_port_mapping[1] = -1;
-			udp_port_mapping[0] = -1;
-			udp_port_mapping[1] = -1;
+			tcp_port_mapping[0] = port_mapping_t{-1};
+			tcp_port_mapping[1] = port_mapping_t{-1};
+			udp_port_mapping[0] = port_mapping_t{-1};
+			udp_port_mapping[1] = port_mapping_t{-1};
 		}
 
 		// listen_socket_t should not be copied or moved because
@@ -180,8 +180,8 @@ namespace aux {
 		int udp_external_port = 0;
 
 		// 0 is natpmp 1 is upnp
-		int tcp_port_mapping[2];
-		int udp_port_mapping[2];
+		port_mapping_t tcp_port_mapping[2];
+		port_mapping_t udp_port_mapping[2];
 
 		// indicates whether this is an SSL listen socket or not
 		transport ssl = transport::plaintext;
@@ -433,7 +433,7 @@ namespace aux {
 
 			// called when a port mapping is successful, or a router returns
 			// a failure to map a port
-			void on_port_mapping(int mapping, address const& ip, int port
+			void on_port_mapping(port_mapping_t mapping, address const& ip, int port
 				, portmap_protocol proto, error_code const& ec
 				, portmap_transport transport) override;
 
@@ -633,9 +633,9 @@ namespace aux {
 			void stop_natpmp();
 			void stop_upnp();
 
-			int add_port_mapping(portmap_protocol t, int external_port
+			port_mapping_t add_port_mapping(portmap_protocol t, int external_port
 				, int local_port);
-			void delete_port_mapping(int handle);
+			void delete_port_mapping(port_mapping_t handle);
 
 			int next_port() const;
 

include/libtorrent/natpmp.hpp

@@ -55,9 +55,9 @@ struct TORRENT_EXTRA_EXPORT natpmp
 
 	// maps the ports, if a port is set to 0
 	// it will not be mapped
-	int add_mapping(portmap_protocol p, int external_port, tcp::endpoint local_ep);
-	void delete_mapping(int mapping_index);
-	bool get_mapping(int mapping_index, int& local_port, int& external_port
+	port_mapping_t add_mapping(portmap_protocol p, int external_port, tcp::endpoint local_ep);
+	void delete_mapping(port_mapping_t mapping_index);
+	bool get_mapping(port_mapping_t mapping_index, int& local_port, int& external_port
 		, portmap_protocol& protocol) const;
 
 	void close();
@@ -66,15 +66,15 @@ struct TORRENT_EXTRA_EXPORT natpmp
 
 	std::shared_ptr<natpmp> self() { return shared_from_this(); }
 
-	void update_mapping(int i);
-	void send_map_request(int i);
+	void update_mapping(port_mapping_t i);
+	void send_map_request(port_mapping_t i);
 	void send_get_ip_address_request();
-	void resend_request(int i, error_code const& e);
+	void resend_request(port_mapping_t i, error_code const& e);
 	void on_reply(error_code const& e
 		, std::size_t bytes_transferred);
-	void try_next_mapping(int i);
+	void try_next_mapping(port_mapping_t i);
 	void update_expiration_timer();
-	void mapping_expired(error_code const& e, int i);
+	void mapping_expired(error_code const& e, port_mapping_t i);
 	void close_impl();
 
 	void disable(error_code const& ec);
@@ -100,15 +100,15 @@ struct TORRENT_EXTRA_EXPORT natpmp
 
 	aux::portmap_callback& m_callback;
 
-	aux::vector<mapping_t> m_mappings;
+	aux::vector<mapping_t, port_mapping_t> m_mappings;
 
 	// the endpoint to the nat router
 	udp::endpoint m_nat_endpoint;
 
 	// this is the mapping that is currently
 	// being updated. It is -1 in case no
 	// mapping is being updated at the moment
-	int m_currently_mapping = -1;
+	port_mapping_t m_currently_mapping{-1};
 
 	// current retry count
 	int m_retry_count = 0;
@@ -134,7 +134,7 @@ struct TORRENT_EXTRA_EXPORT natpmp
 	deadline_timer m_refresh_timer;
 
 	// the mapping index that will expire next
-	int m_next_refresh = -1;
+	port_mapping_t m_next_refresh{-1};
 
 	bool m_disabled = false;
 

include/libtorrent/portmap.hpp

@@ -34,8 +34,12 @@ POSSIBILITY OF SUCH DAMAGE.
 #define TORRENT_PORTMAP_HPP_INCLUDED
 
 #include "libtorrent/config.hpp"
+#include "libtorrent/units.hpp"
 
 namespace libtorrent {
+namespace aux {
+	struct port_mapping_tag;
+}
 
 	enum class portmap_transport : std::uint8_t
 	{
@@ -47,6 +51,9 @@ namespace libtorrent {
 		none, tcp, udp
 	};
 
+	// this type represents an index referring to a port mapping
+	using port_mapping_t = aux::strong_typedef<int, aux::port_mapping_tag>;
+
 }
 
 #endif  //TORRENT_PORTMAP_HPP_INCLUDED

include/libtorrent/session_handle.hpp

@@ -1004,8 +1004,8 @@ namespace libtorrent {
 		// whichever is enabled. The return value is a handle referring to the
 		// port mapping that was just created. Pass it to delete_port_mapping()
 		// to remove it.
-		int add_port_mapping(portmap_protocol t, int external_port, int local_port);
-		void delete_port_mapping(int handle);
+		port_mapping_t add_port_mapping(portmap_protocol t, int external_port, int local_port);
+		void delete_port_mapping(port_mapping_t handle);
 
 		// This function is intended only for use by plugins. This type does
 		// not have a stable API and should be relied on as little as possible.

include/libtorrent/units.hpp

@@ -43,7 +43,7 @@ POSSIBILITY OF SUCH DAMAGE.
 
 namespace libtorrent { namespace aux {
 	template <typename Tag>
-	struct difference_tag {};
+	struct difference_tag;
 
 	template<typename UnderlyingType, typename Tag
 		, typename Cond = typename std::enable_if<std::is_integral<UnderlyingType>::value>::type>

include/libtorrent/upnp.hpp

@@ -172,13 +172,13 @@ struct TORRENT_EXTRA_EXPORT upnp final
 	// 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.
-	int add_mapping(portmap_protocol p, int external_port, tcp::endpoint local_ep);
+	port_mapping_t add_mapping(portmap_protocol p, int external_port, tcp::endpoint local_ep);
 
 	// 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().
-	void delete_mapping(int mapping_index);
+	void delete_mapping(port_mapping_t mapping_index);
 
-	bool get_mapping(int mapping_index, tcp::endpoint& local_ep, int& external_port
+	bool get_mapping(port_mapping_t mapping_index, tcp::endpoint& local_ep, int& external_port
 		, portmap_protocol& protocol) const;
 
 	void discover_device();
@@ -207,8 +207,8 @@ struct TORRENT_EXTRA_EXPORT upnp final
 		, std::size_t bytes_transferred);
 
 	struct rootdevice;
-	void next(rootdevice& d, int i);
-	void update_map(rootdevice& d, int i);
+	void next(rootdevice& d, port_mapping_t i);
+	void update_map(rootdevice& d, port_mapping_t i);
 
 	void on_upnp_xml(error_code const& e
 		, libtorrent::http_parser const& p, rootdevice& d
@@ -218,22 +218,22 @@ struct TORRENT_EXTRA_EXPORT upnp final
 		, http_connection& c);
 	void on_upnp_map_response(error_code const& e
 		, libtorrent::http_parser const& p, rootdevice& d
-		, int mapping, http_connection& c);
+		, port_mapping_t mapping, http_connection& c);
 	void on_upnp_unmap_response(error_code const& e
 		, libtorrent::http_parser const& p, rootdevice& d
-		, int mapping, http_connection& c);
+		, port_mapping_t mapping, http_connection& c);
 	void on_expire(error_code const& e);
 
 	void disable(error_code const& ec);
-	void return_error(int mapping, int code);
+	void return_error(port_mapping_t mapping, int code);
 #ifndef TORRENT_DISABLE_LOGGING
 	bool should_log() const;
 	void log(char const* msg, ...) const TORRENT_FORMAT(2,3);
 #endif
 
 	void get_ip_address(rootdevice& d);
-	void delete_port_mapping(rootdevice& d, int i);
-	void create_port_mapping(http_connection& c, rootdevice& d, int i);
+	void delete_port_mapping(rootdevice& d, port_mapping_t i);
+	void create_port_mapping(http_connection& c, rootdevice& d, port_mapping_t i);
 	void post(upnp::rootdevice const& d, char const* soap
 		, char const* soap_action);
 
@@ -278,7 +278,7 @@ struct TORRENT_EXTRA_EXPORT upnp final
 		// either the WANIP namespace or the WANPPP namespace
 		std::string service_namespace;
 
-		aux::vector<mapping_t> mapping;
+		aux::vector<mapping_t, port_mapping_t> mapping;
 
 		// this is the hostname, port and path
 		// component of the url or the control_url
@@ -326,11 +326,11 @@ struct TORRENT_EXTRA_EXPORT upnp final
 
 	struct upnp_state_t
 	{
-		std::vector<global_mapping_t> mappings;
+		aux::vector<global_mapping_t, port_mapping_t> mappings;
 		std::set<rootdevice> devices;
 	};
 
-	aux::vector<global_mapping_t> m_mappings;
+	aux::vector<global_mapping_t, port_mapping_t> m_mappings;
 
 	std::string m_user_agent;
 

src/alert.cpp

@@ -1072,7 +1072,7 @@ namespace {
 	}
 
 	portmap_error_alert::portmap_error_alert(aux::stack_allocator&
-		, int i, portmap_transport const t, error_code const& e)
+		, port_mapping_t const i, portmap_transport const t, error_code const& e)
 		: mapping(i)
 		, map_transport(t)
 		, error(e)
@@ -1089,7 +1089,8 @@ namespace {
 			+ ": " + convert_from_native(error.message());
 	}
 
-	portmap_alert::portmap_alert(aux::stack_allocator&, int i, int port
+	portmap_alert::portmap_alert(aux::stack_allocator&, port_mapping_t const i
+		, int port
 		, portmap_transport const t
 		, portmap_protocol const proto)
 		: mapping(i)