sip-listener (Sun GlassFish Communications Server 1.5 Administration Reference)

Sun GlassFish Communications Server 1.5 Administration Reference

sip-listener

Defines a SIP service listen socket. The connection-pool subelement of the parent sip-service element also configures some listen socket settings.

The following table describes subelements for the sip-listener element.

Table 1–194 sip-listener Subelements


Element	Required	Description
ssl	zero or one	Defines Secure Socket Layer (SSL) parameters.
property	zero or more	Specifies a property or a variable.

The following table describes attributes for the sip-listener element.

Table 1–195 sip-listener Attributes


Attribute	Default	Description
`id`	none	The unique listener name. A `sip-listener` name cannot begin with a number.
`address`	none	IP address of the listener. Can be in dotted-pair or IPv6 notation. Can be `any` (for `INADDR_ANY`) to listen on all IP addresses. Can be a hostname.
`port`	`5060` (non-TLS) `5061` (TLS)	Port number on which the listener listens. Legal values are `1` - `65535`. On UNIX, creating sockets that listen on ports `1` - `1024` requires superuser privileges.
`transport`	`udp_tcp`	(optional) Specifies the type of transport layer protocol. Allowed values are `udp_tcp` and `tls`.
`enabled`	`true`	(optional) Determines whether the listener is active. If set to `false`, any attempts to connect to the listener result in a socket exception (`java.net.ConnectException`).

The following table describes properties for the sip-listener element.

Table 1–196 sip-listener Properties


Property	Default	Description
`DisableTimeout`	`0`	Specifies the number of seconds after a `sip-listener` is disabled for the listener to complete in-flight transactions. During this timeout period no new requests are accepted.
`CloseServerSocketDuringDisable`	`false`	If `true`, specifies that the server socket (5060) has to be closed during the `DisableTimeout` period.