Real-Time Communications (rtcomm)

Defines the configuration that is related to the Rtcomm feature and all its related components. All the real-time capabilities associated with the Rtcomm feature are configured under this single entity.

Name	Type	Default	Description
MQTT broker connection
messageServerHost	string	localhost	The host of the MQTT broker. The specified host can be an IP address or domain name server (DNS) hostname.
messageServerPort	int	1883	The port the MQTT broker listens on. The port is any valid port number.
rtcommTopicPath	string	/rtcomm/	The MQTT topic path that is associated with this feature. All Rtcomm topic names configured within Rtcomm Options are prepended with this path. To create a unique name space for this Rtcomm instance within a message broker, modify this path to be unique.
sharedSubscriptionPath	string		Specifies the shared subscription path that is prepended to the topic path. This path is required by message brokers when using shared subscriptions.
sslEnabled	boolean	false	Uses SSL between the Rtcomm feature and the MQTT broker.
sslRef	A reference to top level ssl element (string).		ID of the SSL configuration to be used to connect to the SSL-enabled MQTT broker.
Signaling
alternateEndpointRoutingEnabled	boolean	false	Enables the alternate endpoint routing option. Administrators that want to control endpoint routing must enable this option.
iceServerURL	string		Specifies the Interactive Connectivity Establishment (ICE) Server URL(s) available for client use. The client can request the list of ICE Server URL(s) for use with WebRTC by using an Rtcomm service query. This following is an example format for an ICE Server URL: - stun:hostname:port.

Name

Type

Default

Description

MQTT broker connection

messageServerHost

string

localhost

The host of the MQTT broker. The specified host can be an IP address or domain name server (DNS) hostname.

messageServerPort

int

1883

The port the MQTT broker listens on. The port is any valid port number.

rtcommTopicPath

string

/rtcomm/

The MQTT topic path that is associated with this feature. All Rtcomm topic names configured within Rtcomm Options are prepended with this path. To create a unique name space for this Rtcomm instance within a message broker, modify this path to be unique.

sharedSubscriptionPath

string

Specifies the shared subscription path that is prepended to the topic path. This path is required by message brokers when using shared subscriptions.

sslEnabled

boolean

false

Uses SSL between the Rtcomm feature and the MQTT broker.

sslRef

A reference to top level ssl element (string).

ID of the SSL configuration to be used to connect to the SSL-enabled MQTT broker.

Signaling

alternateEndpointRoutingEnabled

boolean

false

Enables the alternate endpoint routing option. Administrators that want to control endpoint routing must enable this option.

iceServerURL

string

Specifies the Interactive Connectivity Establishment (ICE) Server URL(s) available for client use. The client can request the list of ICE Server URL(s) for use with WebRTC by using an Rtcomm service query. This following is an example format for an ICE Server URL: - stun:hostname:port.

callQueue

Defines a single instance of a call queue. This instance fully encapsulates all the configuration related to a single queue.

Name	Type	Default	Description
callQueueID	string	callQueueID	The name that is associated with the call queue topic. This is the destination endpoint ID that a caller uses to call into a specific queue.
description	string		Specifies the description of this call queue instance. This description is returned in service query responses and can be used to better inform the client about the queue.
id	string		A unique configuration ID.
timeout	A period of time with second precision	600s	The number of seconds to wait before terminating a call that is waiting in this queue. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Name

Type

Default

Description

callQueueID

string

callQueueID

The name that is associated with the call queue topic. This is the destination endpoint ID that a caller uses to call into a specific queue.

description

string

Specifies the description of this call queue instance. This description is returned in service query responses and can be used to better inform the client about the queue.

string

A unique configuration ID.

timeout

A period of time with second precision

600s

The number of seconds to wait before terminating a call that is waiting in this queue. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

gateway

A WebRTC gateway that provides connectivity from Rtcomm to SIP networks

Name	Type	Default	Description
allowFromSipEndpointRef	List of references to top level sipEndpoint elements (comma-separated string).	defaultSipUAEndpoint	List of SIP endpoints for this connector.
externalPR	string		Host:port address of a SIP Proxy/Registrar. If assigned, all outgoing SIP messages are forwarded to this address
sipContainer	boolean	false	Outgoing SIP messages are routed to SIP applications installed locally

Name

Type

Default

Description

allowFromSipEndpointRef

List of references to top level sipEndpoint elements (comma-separated string).

defaultSipUAEndpoint

List of SIP endpoints for this connector.

externalPR

string

Host:port address of a SIP Proxy/Registrar. If assigned, all outgoing SIP messages are forwarded to this address

sipContainer

boolean

false

Outgoing SIP messages are routed to SIP applications installed locally

gateway > allowFromSipEndpoint

List of SIP endpoints for this connector.

Name	Type	Default	Description
bindRetries	int	60	The number of retries that are attempted when port binding is unsuccessful.
bindRetryDelay	A period of time with millisecond precision	5000ms	The delay between retries in milliseconds. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
host	string	localhost	The IP of the endpoint host
id	string		A unique configuration ID.
sipTCPPort	int	5060	The TCP port used by the SIP endpoint. Use -1 to disable this port.
sipTLSPort	int	5061	The TLS port used by the SIP endpoint. Use -1 to disable this port.
sipUDPPort	int	5060	The UDP port used by the SIP endpoint. Use -1 to disable this port.
sslOptionsRef	A reference to top level sslOptions element (string).		Defines SSL protocol settings
tcpOptionsRef	A reference to top level tcpOptions element (string).	defaultTCPOptions	Defines TCP protocol settings

Name

Type

Default

Description

bindRetries

int

The number of retries that are attempted when port binding is unsuccessful.

bindRetryDelay

A period of time with millisecond precision

5000ms

The delay between retries in milliseconds. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

host

string

localhost

The IP of the endpoint host

string

A unique configuration ID.

sipTCPPort

int

5060

The TCP port used by the SIP endpoint. Use -1 to disable this port.

sipTLSPort

int

5061

The TLS port used by the SIP endpoint. Use -1 to disable this port.

sipUDPPort

int

5060

The UDP port used by the SIP endpoint. Use -1 to disable this port.

sslOptionsRef

A reference to top level sslOptions element (string).

Defines SSL protocol settings

tcpOptionsRef

A reference to top level tcpOptions element (string).

defaultTCPOptions

Defines TCP protocol settings

gateway > allowFromSipEndpoint > sslOptions

Defines SSL protocol settings

Name	Type	Default	Description
sessionTimeout	A period of time with second precision	1d	Amount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
sslRef	A reference to top level ssl element (string).		The default SSL configuration repertoire. The default value is defaultSSLConfig.
sslSessionCacheSize	int	100	The maximum number of session objects that can be stored in the cache.
sslSessionTimeout	A period of time with millisecond precision	86400s	The timeout limit for an SSL session that is established by the SSL Channel. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
suppressHandshakeErrors	boolean	false	Disable logging of SSL handshake errors. SSL handshake errors can occur during normal operation, however these messages can be useful when SSL is behaving unexpectedly. If disabled, the message and console logs do not record handshake errors, and the trace log records handshake errors when SSL Channel tracing is on.

Name

Type

Default

Description

sessionTimeout

A period of time with second precision

Amount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

sslRef

A reference to top level ssl element (string).

The default SSL configuration repertoire. The default value is defaultSSLConfig.

sslSessionCacheSize

int

100

The maximum number of session objects that can be stored in the cache.

sslSessionTimeout

A period of time with millisecond precision

86400s

The timeout limit for an SSL session that is established by the SSL Channel. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

suppressHandshakeErrors

boolean

false

Disable logging of SSL handshake errors. SSL handshake errors can occur during normal operation, however these messages can be useful when SSL is behaving unexpectedly. If disabled, the message and console logs do not record handshake errors, and the trace log records handshake errors when SSL Channel tracing is on.

gateway > allowFromSipEndpoint > tcpOptions

Defines TCP protocol settings

Name	Type	Default	Description
acceptThread	boolean	false	If true, then listening ports do not share the same thread for accepting connections. Otherwise, they share the same thread.
addressExcludeList	string		A comma-separated list of addresses that are not allowed to make inbound connections on this endpoint. You can specify IPv4 or IPv6 addresses. All values in an IPv4 or IPv6 address must be represented by a number or by an asterisk wildcard character. As examples, valid IPv4 addresses for this list include ".1.255.0", "254...9", and "1...", and valid IPv6 addresses include "0:::0:007F:0:0001:0001", "F:FF:FFF:FFFF:1:01:001:0001", and "1234::4321::9F9f:::0000".
addressIncludeList	string		A comma-separated list of addresses that are allowed to make inbound connections on this endpoint. You can specify IPv4 or IPv6 addresses. All values in an IPv4 or IPv6 address must be represented by a number or by an asterisk wildcard character. As examples, valid IPv4 addresses for this list include ".1.255.0", "254...9", and "1...", and valid IPv6 addresses include "0:::0:007F:0:0001:0001", "F:FF:FFF:FFFF:1:01:001:0001", and "1234::4321::9F9f:::0000".
hostNameExcludeList	string		A comma-separated list of host names that are not allowed to make inbound connections on this endpoint. Host names are not case-sensitive and can start with an asterisk, which is used as a wildcard character. However, asterisks cannot be elsewhere in the host name. For example, .abc.com is valid, but .abc.* is not valid.
hostNameIncludeList	string		A comma-separated list of host names that are allowed to make inbound connections on this endpoint. Host names are not case-sensitive and can start with an asterisk, which is used as a wildcard character. However, asterisks cannot be elsewhere in the host name. For example, .abc.com is valid, but .abc.* is not valid.
inactivityTimeout	A period of time with millisecond precision	60s	Amount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
maxOpenConnections	int	128000	Defines the maximum number of connections allowed to be open on this endpoint.
portOpenRetries	int Min: 0 Max: 100000	0	Number of retries to open a TCP/IP port during server startup. There will be a one second delay between retries, until the opening is successful or the port open retry number is reached.
soLinger	int Min: -1 Max: 65535	-1	This parameter sets the delay before closing the socket after a close request is received while data is transmitting. Set the value between 0 and 65,536 to specify the delay period in seconds. To disable this setting, set the value to -1.
soReuseAddr	boolean	true	Enables immediate rebind to a port with no active listener.
waitToAccept	boolean	false	Queries whether this TCP Channel will delay accepting connections until the server starts. If false, connections are closed until the server starts. If true, the value for the acceptThread tcpOption is also set to true, and connections are delayed until the server starts.

Name

Type

Default

Description

acceptThread

boolean

false

If true, then listening ports do not share the same thread for accepting connections. Otherwise, they share the same thread.

addressExcludeList

string

A comma-separated list of addresses that are not allowed to make inbound connections on this endpoint. You can specify IPv4 or IPv6 addresses. All values in an IPv4 or IPv6 address must be represented by a number or by an asterisk wildcard character. As examples, valid IPv4 addresses for this list include "*.1.255.0", "254.*.*.9", and "1.*.*.*", and valid IPv6 addresses include "0:*:*:0:007F:0:0001:0001", "F:FF:FFF:FFFF:1:01:001:0001", and "1234:*:4321:*:9F9f:*:*:0000".

addressIncludeList

string

A comma-separated list of addresses that are allowed to make inbound connections on this endpoint. You can specify IPv4 or IPv6 addresses. All values in an IPv4 or IPv6 address must be represented by a number or by an asterisk wildcard character. As examples, valid IPv4 addresses for this list include "*.1.255.0", "254.*.*.9", and "1.*.*.*", and valid IPv6 addresses include "0:*:*:0:007F:0:0001:0001", "F:FF:FFF:FFFF:1:01:001:0001", and "1234:*:4321:*:9F9f:*:*:0000".

hostNameExcludeList

string

A comma-separated list of host names that are not allowed to make inbound connections on this endpoint. Host names are not case-sensitive and can start with an asterisk, which is used as a wildcard character. However, asterisks cannot be elsewhere in the host name. For example, *.abc.com is valid, but *.abc.* is not valid.

hostNameIncludeList

string

A comma-separated list of host names that are allowed to make inbound connections on this endpoint. Host names are not case-sensitive and can start with an asterisk, which is used as a wildcard character. However, asterisks cannot be elsewhere in the host name. For example, *.abc.com is valid, but *.abc.* is not valid.

inactivityTimeout

A period of time with millisecond precision

60s

Amount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

maxOpenConnections

int

128000

Defines the maximum number of connections allowed to be open on this endpoint.

portOpenRetries

int
Min: 0
Max: 100000

Number of retries to open a TCP/IP port during server startup. There will be a one second delay between retries, until the opening is successful or the port open retry number is reached.

soLinger

int
Min: -1
Max: 65535

-1

This parameter sets the delay before closing the socket after a close request is received while data is transmitting. Set the value between 0 and 65,536 to specify the delay period in seconds. To disable this setting, set the value to -1.

soReuseAddr

boolean

true

Enables immediate rebind to a port with no active listener.

waitToAccept

boolean

false

Queries whether this TCP Channel will delay accepting connections until the server starts. If false, connections are closed until the server starts. If true, the value for the acceptThread tcpOption is also set to true, and connections are delayed until the server starts.