org.linphone.core

Interface LinphoneNatPolicy

public interface LinphoneNatPolicy

Policy to use to pass through NATs/firewalls.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear a NAT policy (deactivate all protocols and unset the STUN server).
void	enableIce(boolean enable) Enable ICE.
void	enableStun(boolean enable) Enable STUN.
void	enableTurn(boolean enable) Enable TURN.
void	enableUpnp(boolean enable) Enable uPnP.
String	getStunServer() Get the STUN/TURN server to use with this NAT policy.
String	getStunServerUsername() Get the username used to authenticate with the STUN/TURN server.
boolean	iceEnabled() Tell whether ICE is enabled.
void	setStunServer(String stun_server) Set the STUN/TURN server to use with this NAT policy.
void	setStunServerUsername(String username) Set the username used to authenticate with the STUN/TURN server.
boolean	stunEnabled() Tell whether STUN is enabled.
boolean	turnEnabled() Tell whether TURN is enabled.
boolean	upnpEnabled() Tell whether uPnP is enabled.

Method Detail

clear

void clear()

Clear a NAT policy (deactivate all protocols and unset the STUN server).

stunEnabled

boolean stunEnabled()

Tell whether STUN is enabled.

Returns:

Boolean value telling whether STUN is enabled.

enableStun

void enableStun(boolean enable)

Enable STUN. If TURN is also enabled, TURN will be used instead of STUN.

Parameters:

enable - Boolean value telling whether to enable STUN.

turnEnabled

boolean turnEnabled()

Tell whether TURN is enabled.

Returns:

Boolean value telling whether TURN is enabled.

enableTurn

void enableTurn(boolean enable)

Enable TURN. If STUN is also enabled, it is ignored and TURN is used.

Parameters:

enable - Boolean value telling whether to enable TURN.

iceEnabled

boolean iceEnabled()

Tell whether ICE is enabled.

Returns:

Boolean value telling whether ICE is enabled.

enableIce

void enableIce(boolean enable)

Enable ICE. ICE can be enabled without STUN/TURN, in which case only the local candidates will be used.

Parameters:

enable - Boolean value telling whether to enable ICE.

upnpEnabled

boolean upnpEnabled()

Tell whether uPnP is enabled.

Returns:

Boolean value telling whether uPnP is enabled.

enableUpnp

void enableUpnp(boolean enable)

Enable uPnP. This has the effect to disable every other policies (ICE, STUN and TURN).

Parameters:

enable - Boolean value telling whether to enable uPnP.

getStunServer

String getStunServer()

Get the STUN/TURN server to use with this NAT policy. Used when STUN or TURN are enabled.

Returns:

The STUN server used by this NAT policy.

setStunServer

void setStunServer(String stun_server)

Set the STUN/TURN server to use with this NAT policy. Used when STUN or TURN are enabled.

Parameters:

stun_server - The STUN server to use with this NAT policy.

getStunServerUsername

String getStunServerUsername()

Get the username used to authenticate with the STUN/TURN server. The authentication will search for a LinphoneAuthInfo with this username. If it is not set the username of the currently used LinphoneProxyConfig is used to search for a LinphoneAuthInfo.

Returns:

The username used to authenticate with the STUN/TURN server.

setStunServerUsername

void setStunServerUsername(String username)

Set the username used to authenticate with the STUN/TURN server. The authentication will search for a LinphoneAuthInfo with this username. If it is not set the username of the currently used LinphoneProxyConfig is used to search for a LinphoneAuthInfo.

Parameters:

username - The username used to authenticate with the STUN/TURN server.