StunConfig

java.lang.Object
- com.zoiper.zdk.Configurations.StunConfig

```
public class StunConfig
extends java.lang.Object
```
STUN specific account configuration The STUN server allows clients to find out their public address, the type of NAT they are behind and the Internet side port associated by the NAT with a particular local port. This information is used to set up communication between the client and the VoIP provider to establish a call. The STUN protocol is defined in RFC 3489. STUN servers are usually contacted on UDP port 3478, however the server can hint clients to perform tests on alternate IP and port number too (STUN servers can have multiple IP addresses).

Constructor Summary

Constructors
Constructor and Description

StunConfig(long handle)
Constructor storing the pointer/address to the underlying native object

Constructors
Constructor and Description
`StunConfig(long handle)` Constructor storing the pointer/address to the underlying native object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allowOnPrivateAddress()` Gets the configured usage of a STUN server on PRIVATE IP address Configures whether to allow or not using STUN on PRIVATE address.
`void`	`allowOnPrivateAddress(boolean value)` Configures whether a STUN server on PRIVATE IP address may be used Configures whether to allow or not using STUN on PRIVATE address.
`boolean`	`allowWithPrivateSipServer()` Gets the configured usage of STUN when used with SIP server on PRIVATE IP address Configures whether to allow or not using STUN with SIP server on PRIVATE address.
`void`	`allowWithPrivateSipServer(boolean value)` Configures whether a STUN may be used with SIP server on PRIVATE IP address Configures whether to allow or not using STUN with SIP server on PRIVATE address.
`protected void`	`finalize()` Ensures the underlying native object destruction
`long`	`handle()` Gets the pointer/address to the underlying native object
`boolean`	`isEqual(StunConfig comp)` Compares the current configuration with the given one
`boolean`	`stunEnabled()` Gets the use of STUN functionality as described in RFC 3489
`void`	`stunEnabled(boolean value)` Configures the use of STUN functionality as described in RFC 3489
`int`	`stunPort()` Gets the configured port of the STUN server Specifies the port of the STUN server.
`void`	`stunPort(int value)` Configures the port of the STUN server Specifies the port of the STUN server.
`int`	`stunRefresh()` Gets the configured refresh period of the STUN server Specifies how often to refresh the STUN server.
`void`	`stunRefresh(int value)` Configures the refresh period of the STUN server Specifies how often to refresh the STUN server.
`java.lang.String`	`stunServer()` Gets the configured address of the STUN server Configures the address (hostname) of the STUN server.
`void`	`stunServer(java.lang.String value)` Configures the address of the STUN server Configures the address (hostname) of the STUN server.
`boolean`	`useDnsSrvRequests()` Gets the configured use of DNS SRV requests in a STUN server Configures the use of DNS SRV requests to find the given STUN server's address.
`void`	`useDnsSrvRequests(boolean value)` Configures the use of DNS SRV requests in a STUN server Configures the use of DNS SRV requests to find the given STUN server's address.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StunConfig
```
public StunConfig(long handle)
```
    Constructor storing the pointer/address to the underlying native object
    
    Parameters:
    
    handle - Pointer/address to the underlying native object
- Method Detail
  - handle
```
public long handle()
```
    Gets the pointer/address to the underlying native object
    
    Returns:
    
    Pointer/address to the underlying native object
  - finalize
```
protected void finalize()
```
    Ensures the underlying native object destruction
    
    Overrides:
    
    finalize in class java.lang.Object
  - stunEnabled
```
public boolean stunEnabled()
```
    Gets the use of STUN functionality as described in RFC 3489
    Returns:
    0 - disabled
    1 - enabled
  - stunEnabled
```
public void stunEnabled(boolean value)
```
    Configures the use of STUN functionality as described in RFC 3489
    Parameters:
    value -
    
    0 - disabled
    1 - enabled
  - stunServer
```
public java.lang.String stunServer()
```
    Gets the configured address of the STUN server Configures the address (hostname) of the STUN server.
    
    Returns:
    
    Hostname of the server
  - stunServer
```
public void stunServer(java.lang.String value)
```
    Configures the address of the STUN server Configures the address (hostname) of the STUN server.
    
    Parameters:
    
    value - Hostname of the server
  - stunPort
```
public int stunPort()
```
    Gets the configured port of the STUN server Specifies the port of the STUN server. The default port is 3478.
    
    Returns:
    
    The port of the server
  - stunPort
```
public void stunPort(int value)
```
    Configures the port of the STUN server Specifies the port of the STUN server. The default port is 3478.
    
    Parameters:
    
    value - The port of the server
  - stunRefresh
```
public int stunRefresh()
```
    Gets the configured refresh period of the STUN server Specifies how often to refresh the STUN server. The default is 30 seconds. The refresh can be used to keep the NAT mapping alive.
    
    Returns:
    
    The refresh period in milliseconds (30000 default)
    
    See Also:
    
    keepAlive
  - stunRefresh
```
public void stunRefresh(int value)
```
    Configures the refresh period of the STUN server Specifies how often to refresh the STUN server. The default is 30 seconds. The refresh can be used to keep the NAT mapping alive.
    
    Parameters:
    
    value - The refresh period in milliseconds (30000 default)
    
    See Also:
    
    keepAlive
  - useDnsSrvRequests
```
public boolean useDnsSrvRequests()
```
    Gets the configured use of DNS SRV requests in a STUN server Configures the use of DNS SRV requests to find the given STUN server's address. This is disabled by default and must be explicitly set to non-zero for this to work. If SRV requests are enabled, the STUN manager will use all results returned from the SRV query, should any actual STUN requests fail.
    Returns:
    0 - disabled
    1 - enabled
  - useDnsSrvRequests
```
public void useDnsSrvRequests(boolean value)
```
    Configures the use of DNS SRV requests in a STUN server Configures the use of DNS SRV requests to find the given STUN server's address. This is disabled by default and must be explicitly set to non-zero for this to work. If SRV requests are enabled, the STUN manager will use all results returned from the SRV query, should any actual STUN requests fail.
    Parameters:
    value -
    
    0 - disabled
    1 - enabled
  - allowOnPrivateAddress
```
public boolean allowOnPrivateAddress()
```
    Gets the configured usage of a STUN server on PRIVATE IP address Configures whether to allow or not using STUN on PRIVATE address. NOTE! It is not consider a failure to have configured or the resolved STUN server to be on PRIVATE address. In such a cases, the STUN is silently disabled (like done behind SYMMETRIC NATs for example).
    Returns:
    0 - disabled
    1 - enabled
  - allowOnPrivateAddress
```
public void allowOnPrivateAddress(boolean value)
```
    Configures whether a STUN server on PRIVATE IP address may be used Configures whether to allow or not using STUN on PRIVATE address. NOTE! It is not consider a failure to have configured or the resolved STUN server to be on PRIVATE address. In such a cases, the STUN is silently disabled (like done behind SYMMETRIC NATs for example).
    Parameters:
    value -
    
    0 - disabled
    1 - enabled
  - allowWithPrivateSipServer
```
public boolean allowWithPrivateSipServer()
```
    Gets the configured usage of STUN when used with SIP server on PRIVATE IP address Configures whether to allow or not using STUN with SIP server on PRIVATE address. NOTE! It is not consider a failure to have configured or the resolved SIP server to be on PRIVATE address. In such a cases, the STUN is silently disabled (like done behind SYMMETRIC NATs for example).
    Returns:
    0 - disabled
    1 - enabled
  - allowWithPrivateSipServer
```
public void allowWithPrivateSipServer(boolean value)
```
    Configures whether a STUN may be used with SIP server on PRIVATE IP address Configures whether to allow or not using STUN with SIP server on PRIVATE address. NOTE! It is not consider a failure to have configured or the resolved SIP server to be on PRIVATE address. In such a cases, the STUN is silently disabled (like done behind SYMMETRIC NATs for example).
    Parameters:
    value -
    
    0 - disabled
    1 - enabled
  - isEqual
```
public boolean isEqual(StunConfig comp)
```
    Compares the current configuration with the given one
    Parameters:
    
    comp - STUN configuration to be compared
    
    Returns:
    0 - not equal
    1 - equal

Class StunConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StunConfig

Method Detail

handle

finalize

stunEnabled

stunEnabled

stunServer

stunServer

stunPort

stunPort

stunRefresh

stunRefresh

useDnsSrvRequests

useDnsSrvRequests

allowOnPrivateAddress

allowOnPrivateAddress

allowWithPrivateSipServer

allowWithPrivateSipServer

isEqual