NET::UPNP Namespace Reference

Utilities to help bypass NATs. More...

Functions

bool IsAvailable ()

Returns whether UPNP service is available on the network. If this returns false, most other functions here will likely fail.

std::string GetInternetFacingIP ()

Retrieves the public internet-facing IP of the local network. If that information is not available, an the IP of the local machine is returned instead.

std::string GetDeviceName ()

Returns the name of the router device that we are talking to with UPNP.

void ClaimUDPPort (uint16 port)

Instructs the router to redirect all UDP packets sent to a specific port to us.

void ClaimTCPPort (uint16 port)

Instructs the router to redirect all TCP connection attempts to a specific port to us.

void ReleaseUDPPort (uint16 port)

Instructs the router that we are no longer interested in a specific udp port.

void ReleaseTCPPort (uint16 port)

Instructs the router that we are no longer interested in a specific tcp port.

Variables

bool AllowNinjaNatTechniques = true

Whether the framework should attempt to try other nat-opening techniques if UPNP is not available when either of the Claim*Port functions are called. These techniques may include sending out packets and trying to open tcp connections. Default is true.

Detailed Description

Utilities to help bypass NATs.


Functions
bool	IsAvailable ()
	Returns whether UPNP service is available on the network. If this returns false, most other functions here will likely fail.
std::string	GetInternetFacingIP ()
	Retrieves the public internet-facing IP of the local network. If that information is not available, an the IP of the local machine is returned instead.
std::string	GetDeviceName ()
	Returns the name of the router device that we are talking to with UPNP.
void	ClaimUDPPort (uint16 port)
	Instructs the router to redirect all UDP packets sent to a specific port to us.
void	ClaimTCPPort (uint16 port)
	Instructs the router to redirect all TCP connection attempts to a specific port to us.
void	ReleaseUDPPort (uint16 port)
	Instructs the router that we are no longer interested in a specific udp port.
void	ReleaseTCPPort (uint16 port)
	Instructs the router that we are no longer interested in a specific tcp port.
Variables
bool	AllowNinjaNatTechniques = true
	Whether the framework should attempt to try other nat-opening techniques if UPNP is not available when either of the Claim*Port functions are called. These techniques may include sending out packets and trying to open tcp connections. Default is true.