com.zoiper.zdk.Configurations

Class ContextConfiguration

java.lang.Object

com.zoiper.zdk.Configurations.ContextConfiguration

public class ContextConfiguration
extends java.lang.Object

General ZDK/Context configuration The configuration is applied with startContext! Any changes after startContext has been invoked will not take effect until a restart happens - stopContext followed by startContext.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	enableIPv6() Gets the global use of Pv6 support Globally enable Pv6 support.
void	enableIPv6(boolean value) Sets the global use of Pv6 support Globally enable Pv6 support.
boolean	enableSIPReliableProvisioning() Gets the global usage of reliable provisional as described in RFC 3262 The reliability mechanism works by mirroring the current reliability mechanisms for 2xx final responses to NVITE.
void	enableSIPReliableProvisioning(boolean value) Sets the global usage of reliable provisional as described in RFC 3262 The reliability mechanism works by mirroring the current reliability mechanisms for 2xx final responses to NVITE.
protected void	finalize() Ensures the underlying native object destruction
long	handle() Gets the pointer/address to the underlying native object
int	iaxUdpPortInUse() Gets the actually used IAX UDP port In case the requested port was already taken the next available one will be opened.
IpVersionType	ipVersionPreference() Gets the selected preferred IP version Selects which IP version to prefer when resolving DNS.
void	ipVersionPreference(IpVersionType value) Selects the preferred IP version Selects which IP version to prefer when resolving DNS.
int	mediaDSCP() Gets the configured DSCP for the media streams This will affect the RTP, SRTP and AX2 sockets.
void	mediaDSCP(int value) Configures the DSCP for the media streams This will affect the RTP, SRTP and AX2 sockets.
java.lang.String	rtpEmail() Gets the configured e-mail address for SDP Sets the email address to put in SDP offers/answers.
void	rtpEmail(java.lang.String value) Configures the e-mail address for SDP Sets the email address to put in SDP offers/answers.
int	rtpPort() Gets the base port to be used for RTP streams Get the base UDP port to use for RTP streams.
void	rtpPort(int value) Sets the base port to be used for RTP streams Set the base UDP port to use for RTP streams.
java.lang.String	rtpSessionName() Gets the configured RTP session name for the SDP Sets the RTP session name for the SDP offers/answers.
void	rtpSessionName(java.lang.String value) Configures the RTP session name for the SDP Sets the RTP session name for the SDP offers/answers.
java.lang.String	rtpUrl() Gets the configured URL for SDP Sets the URL for the SDP offers/answers.
void	rtpUrl(java.lang.String value) Configures the URL for SDP Sets the URL for the SDP offers/answers.
java.lang.String	rtpUsername() Gets the configured RTP user name for the SDP Sets the RTP user name for the SDP offers/answers.
void	rtpUsername(java.lang.String value) Configures the RTP user name for the SDP Sets the RTP user name for the SDP offers/answers.
int	signalDSCP() Gets the configured DSCP for the signaling streams This will affect the SIP sockets (UDP, TCP and TLS).
void	signalDSCP(int value) Configures the DSCP for the signaling streams This will affect the SIP sockets (UDP, TCP and TLS).
int	sipTcpPort() Gets the requested SIP TCP port to be used In case the requested port was already taken the next available one will be opened.
void	sipTcpPort(int value) Sets the requested SIP TCP port to be used In case the requested port was already taken the next available one will be opened.
int	sipTcpPortInUse() Gets the actually used SIP TCP port In case the requested port was already taken the next available one will be opened.
int	sipTlsPort() Gets the requested SIP TLS port to be used In case the requested port was already taken the next available one will be opened.
void	sipTlsPort(int value) Sets the requested SIP TCP port to be used In case the requested port was already taken the next available one will be opened.
int	sipTlsPortInUse() Gets the actually used SIP TLS port In case the requested port was already taken the next available one will be opened.
int	sipUdpPort() Gets the requested SIP UDP port to be used In case the requested port was already taken the next available one will be opened.
void	sipUdpPort(int value) Sets the requested SIP UDP port to be used In case the requested port was already taken the next available one will be opened.
int	sipUdpPortInUse() Gets the actually used SIP UDP port In case the requested port was already taken the next available one will be opened.
java.lang.String	userAgent() Gets the ZDK's user agent Used in SIP messages mainly.
void	userAgent(java.lang.String value) Sets the ZDK's user agent Used in SIP messages mainly.
java.lang.String	userSipInstance() Generate a random UUID to be used for SIP user instance Generates a valid RFC 4122 (RFC 2141) UUID URN that can be used for RFC 5626 (SIP Outbound).

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContextConfiguration

public ContextConfiguration(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

sipUdpPort

public int sipUdpPort()

Gets the requested SIP UDP port to be used In case the requested port was already taken the next available one will be opened. Default is 5060. Use the value of 0 to use an OS-assigned random port.

Returns:

The requested local UDP port for SIP UDP to be used, or 0 for random port to be used

See Also:

sipTcpPort sipTcpPortInUse sipTlsPort sipTlsPortInUse

sipUdpPort

public void sipUdpPort(int value)

Sets the requested SIP UDP port to be used In case the requested port was already taken the next available one will be opened. Default is 5060. Use the value of 0 to use an OS-assigned random port.

Parameters:

value - The requested local UDP port for SIP UDP to be used, or 0 for random port to be used

See Also:

sipTcpPort sipTcpPortInUse sipTlsPort sipTlsPortInUse

sipUdpPortInUse

public int sipUdpPortInUse()

Gets the actually used SIP UDP port In case the requested port was already taken the next available one will be opened. Default is the sipUdpPort. !!! Works ONLY AFTER startContext !!!

Returns:

The local UDP port for SIP UDP. "-1" in case of not initialized or error!

See Also:

sipTcpPort sipTcpPortInUse sipTlsPort sipTlsPortInUse

sipTcpPort

public int sipTcpPort()

Gets the requested SIP TCP port to be used In case the requested port was already taken the next available one will be opened. Use the value of -1 to try to open the same as UDP (default). Use the value of 0 to use an OS-assigned random port.

Returns:

The requested local TCP port for SIP TCP to be used

See Also:

sipUdpPortInUse sipTcpPortInUse sipTlsPort sipTlsPortInUse

sipTcpPort

public void sipTcpPort(int value)

Sets the requested SIP TCP port to be used In case the requested port was already taken the next available one will be opened. Use the value of -1 to try to open the same as UDP (default). Use the value of 0 to use an OS-assigned random port.

Parameters:

value - The requested local TCP port for SIP TCP to be used

See Also:

sipUdpPortInUse sipTcpPortInUse sipTlsPort sipTlsPortInUse

sipTcpPortInUse

public int sipTcpPortInUse()

Gets the actually used SIP TCP port In case the requested port was already taken the next available one will be opened. Default is the sipUdpPort. !!! Works ONLY AFTER startContext !!!

Returns:

The local TCP port for SIP TCP. "-1" in case of not initialized or error!

See Also:

sipUdpPortInUse sipTcpPort sipTlsPort sipTlsPortInUse

sipTlsPort

public int sipTlsPort()

Gets the requested SIP TLS port to be used In case the requested port was already taken the next available one will be opened. Use the value of -1 to try to open the next available port after the TCP one (sipTcpPort+1) (default). Use the value of 0 to use an OS-assigned random port.

Returns:

The requested local TCP port for SIP TLS (not a mistake, TLS run on top of TCP).

See Also:

sipUdpPortInUse sipTcpPort sipTcpPortInUse sipTlsPortInUse

sipTlsPort

public void sipTlsPort(int value)

Sets the requested SIP TCP port to be used In case the requested port was already taken the next available one will be opened. Use the value of -1 to try to open the next available port after the TCP one (sipTcpPort+1) (default). Use the value of 0 to use an OS-assigned random port.

Parameters:

value - The requested local TCP port for SIP TLS to be used (not a mistake, TLS run on top of TCP)

See Also:

sipUdpPortInUse sipTcpPort sipTcpPortInUse sipTlsPortInUse

sipTlsPortInUse

public int sipTlsPortInUse()

Gets the actually used SIP TLS port In case the requested port was already taken the next available one will be opened. Default is the sipTcpPort+1. !!! Works ONLY AFTER startContext !!!

Returns:

The local TCP port for SIP TLS (not a mistake, TLS run on top of TCP). "-1" in case of not initialized or error!

See Also:

sipUdpPortInUse sipTcpPort sipTcpPortInUse sipTlsPort

iaxUdpPortInUse

public int iaxUdpPortInUse()

Gets the actually used IAX UDP port In case the requested port was already taken the next available one will be opened. !!! Works ONLY AFTER context::AddProtocol !!!

Returns:

The local UDP port for IAX. "-1" in case of not initialized or error!

rtpPort

public int rtpPort()

Gets the base port to be used for RTP streams Get the base UDP port to use for RTP streams. Default is 8000. Each call uses two UDP ports, one for the actual audio stream and another one for the control (RTCP) packets. A free port will be searched for from that base upwards for each call. When the call is finished the port will be reused in the future. Use the value of 0 to use an OS-assigned random port.

Returns:

The RTP port base, or 0 for random port to be used

rtpPort

public void rtpPort(int value)

Sets the base port to be used for RTP streams Set the base UDP port to use for RTP streams. Default is 8000. Each call uses two UDP ports, one for the actual audio stream and another one for the control (RTCP) packets. A free port will be searched for from that base upwards for each call. When the call is finished the port will be reused in the future. Use the value of 0 to use an OS-assigned random port.

Parameters:

value - The RTP port base, or 0 for random port to be used

enableIPv6

public boolean enableIPv6()

Gets the global use of Pv6 support Globally enable Pv6 support. Once enabled all networking will still try to go through Pv4 first, if possible, before trying Pv6. The Pv6 will be used as a backup in case Pv4 is either not available or inaccessible.

Returns:

• 0 - disabled
• 1 - enabled

enableIPv6

public void enableIPv6(boolean value)

Sets the global use of Pv6 support Globally enable Pv6 support. Once enabled all networking will still try to go through Pv4 first, if possible, before trying Pv6. The Pv6 will be used as a backup in case Pv4 is either not available or inaccessible.

Parameters:

value -

• 0 - disabled
• 1 - enabled

ipVersionPreference

public IpVersionType ipVersionPreference()

Gets the selected preferred IP version Selects which IP version to prefer when resolving DNS. If Pv6 is selected, but not available/enabled, will fallback to the default "Automatic".

Returns:

The desired preference

See Also:

IpVersionType

ipVersionPreference

public void ipVersionPreference(IpVersionType value)

Selects the preferred IP version Selects which IP version to prefer when resolving DNS. If Pv6 is selected, but not available/enabled, will fallback to the default "Automatic".

Parameters:

value - The desired preference

See Also:

IpVersionType

userSipInstance

public java.lang.String userSipInstance()

Generate a random UUID to be used for SIP user instance Generates a valid RFC 4122 (RFC 2141) UUID URN that can be used for RFC 5626 (SIP Outbound). The result is a string in the format "urn:uuid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx". The prefix is there for easier use of sipInstance.

Returns:

Generated UUID URN

See Also:

sipInstance

enableSIPReliableProvisioning

public boolean enableSIPReliableProvisioning()

Gets the global usage of reliable provisional as described in RFC 3262 The reliability mechanism works by mirroring the current reliability mechanisms for 2xx final responses to NVITE. The PRACK request plays the same role as ACK, but for provisional responses. There is an important difference, however. PRACK is a normal SIP message, like BYE. As such, its own reliability is ensured hop-by-hop through each stateful proxy. Also like BYE, but unlike ACK, PRACK has its own response. Extending the Session Initiation Protocol (SIP) - RFC 3262.

Returns:

• 0 - disabled
• 1 - enabled

enableSIPReliableProvisioning

public void enableSIPReliableProvisioning(boolean value)

Sets the global usage of reliable provisional as described in RFC 3262 The reliability mechanism works by mirroring the current reliability mechanisms for 2xx final responses to NVITE. The PRACK request plays the same role as ACK, but for provisional responses. There is an important difference, however. PRACK is a normal SIP message, like BYE. As such, its own reliability is ensured hop-by-hop through each stateful proxy. Also like BYE, but unlike ACK, PRACK has its own response. Extending the Session Initiation Protocol (SIP) - RFC 3262.

Parameters:

value -

• 0 - disabled
• 1 - enabled

userAgent

public java.lang.String userAgent()

Gets the ZDK's user agent Used in SIP messages mainly. (User-Agent header field).

Returns:

value UTF-8 encoded user agent

userAgent

public void userAgent(java.lang.String value)

Sets the ZDK's user agent Used in SIP messages mainly. (User-Agent header field).

Parameters:

value - UTF-8 encoded user agent

mediaDSCP

public int mediaDSCP()

Gets the configured DSCP for the media streams This will affect the RTP, SRTP and AX2 sockets. Might require administrative privileges.

Returns:

The DiffServ Code Point

See Also:

signalDSCP

mediaDSCP

public void mediaDSCP(int value)

Configures the DSCP for the media streams This will affect the RTP, SRTP and AX2 sockets. Might require administrative privileges.

Parameters:

value - The DiffServ Code Point

See Also:

signalDSCP

signalDSCP

public int signalDSCP()

Gets the configured DSCP for the signaling streams This will affect the SIP sockets (UDP, TCP and TLS).

Returns:

The DiffServ Code Point

See Also:

mediaDSCP

signalDSCP

public void signalDSCP(int value)

Configures the DSCP for the signaling streams This will affect the SIP sockets (UDP, TCP and TLS).

Parameters:

value - The DiffServ Code Point

See Also:

mediaDSCP

rtpSessionName

public java.lang.String rtpSessionName()

Gets the configured RTP session name for the SDP Sets the RTP session name for the SDP offers/answers. The name should not contain spaces.

Returns:

RTP session name

See Also:

rtpUsername rtpUrl rtpEmail

rtpSessionName

public void rtpSessionName(java.lang.String value)

Configures the RTP session name for the SDP Sets the RTP session name for the SDP offers/answers. The name should not contain spaces.

Parameters:

value - RTP session name

See Also:

rtpUsername rtpUrl rtpEmail

rtpUsername

public java.lang.String rtpUsername()

Gets the configured RTP user name for the SDP Sets the RTP user name for the SDP offers/answers. The user name should not contain spaces.

Returns:

RTP user name

See Also:

rtpSessionName rtpUrl rtpEmail

rtpUsername

public void rtpUsername(java.lang.String value)

Configures the RTP user name for the SDP Sets the RTP user name for the SDP offers/answers. The user name should not contain spaces.

Parameters:

value - RTP user name

See Also:

rtpSessionName rtpUrl rtpEmail

rtpUrl

public java.lang.String rtpUrl()

Gets the configured URL for SDP Sets the URL for the SDP offers/answers. This is optional.

Returns:

The URL

See Also:

rtpSessionName rtpUsername rtpEmail

rtpUrl

public void rtpUrl(java.lang.String value)

Configures the URL for SDP Sets the URL for the SDP offers/answers. This is optional.

Parameters:

value - The URL

See Also:

rtpSessionName rtpUsername rtpEmail

rtpEmail

public java.lang.String rtpEmail()

Gets the configured e-mail address for SDP Sets the email address to put in SDP offers/answers. This is optional.

Returns:

The e-mail address

See Also:

rtpSessionName rtpUsername rtpUrl

rtpEmail

public void rtpEmail(java.lang.String value)

Configures the e-mail address for SDP Sets the email address to put in SDP offers/answers. This is optional.

Parameters:

value - The e-mail address

See Also:

rtpSessionName rtpUsername rtpUrl