(dist)(iseries)

SIP UDP transport channel custom properties

We can add the following custom properties to the configuration settings for the Session Initiation Protocol(SIP) UDP transport channel.

To specify custom properties for a specific UDP transport channel, navigate to the custom properties page, and specify a value for the custom property.

Important: The custom properties are supported as the primary method of configuration. If a custom property is set and then set the corresponding setting in the console, the custom property value is used.

  1. In the console, open the configuration tab for the server...

      Servers | Server Types | WebSphere application servers | [server_name | Servers] | Server Types | WebSphere proxy servers | proxy_server_name

  2. From SIP container settings or SIP proxy server settings, expand SIP container transport chains or SIP proxy server transports, and click UDP specific chain, and select UDP inbound channel.

  3. From Additional properties, select Custom properties > New.

  4. On the settings page, type the custom property to configure in the Name field, and type the value of the custom property in the Value field.

  5. Click Apply or OK.

  6. Click Save on the console task bar to save the configuration changes.

  7. Restart the server.

The following list of UDP transport channel custom properties is provided with the product. These properties are not shown on the settings page for a UDP transport channel.


autoCreateConnLink

Whether to make the UDP client-side interface active without actually receiving packets over it.

Unless you add this property to the SIP proxy server settings, the SIP proxy server cannot send UDP messages outbound because it does not have an active client-side interface. Typically, the SIP proxy server sends a UDP message to the client-side interface to activate the interface. If a message cannot be sent, SIP messages are sent from the container to the proxy server, but are then dropped.

Information Value
Data type Boolean
Default false


hideMessageBody

Whether you want the message body included in the SIP proxy server trace messages. By default, the trace messages do not include Authorization or Proxy-Authorization headers. If we also do not want the message body to appear in the trace log, add this custom property to the settings for the SIP inbound channel (SIP 1) and set the property to true.

Information Value
Data type Boolean
Default false


hideMessageHeaders

Specifies one or more of the SIP message headers that we do not want to appear in the SIP proxy server trace messages. If we specify multiple headers, use a comma to separate the header names. By default, the trace messages do not include the Authorization, and Proxy-Authorization headers.

Avoid trouble: If we specify a value for this property, include the Authorization, and Proxy-Authorization values to prevent these headers from being displayed. For example, if specified hideMessageHeaders=Via, only the Via header does not appear in the trace messages. To prevent the Via, Authorization, and Proxy-Authorization headers from appearing in the trace messages, specify hideMessageHeaders=Via,Authorization,Proxy-Authorization.gotcha

Information Value
Data type string
Default Authorization,Proxy-Authorization


hungThreadTimeout

Amount of time you want the SIP proxy server to wait for one of it's UDP threads to be returned before reporting an error.

By default, the SIP proxy server reports an error if any of its UDP threads are not returned to the pool in 30 seconds. If we want to change the length of time that the SIP proxy server waits for a UDP thread to be returned, use this property to specify, in seconds, the length of time you want the SIP proxy server to wait.

Set this property to 0, indicates you want the SIP proxy server to wait for 30 seconds before reporting an error.

Information Value
Data type integer
Default 0


receiveBufferSizeSocket

Value in bytes for the lower level datagram buffers. This is the size of the DatagramSocket receive buffer (SO_RCVBUF) on any inbound User Datagram Protocol (UDP) channel.

Use this property to buffer multiple packets in the DatagramSocket layer. If the value of the property is too small, then packets might be lost if the server is overloaded. If the value is too large, then the packets might be delayed.

Information Value
Data type String
Default 1024000


sendBufferSizeSocket

Value, in bytes, for the lower-level datagram buffers, which is the size of the DatagramSocket send buffer (SO_SNDBUF) on any inbound UDP channel.

Use this property to buffer multiple packets in the DatagramSocket layer. If the value of the property is too small, then packets might be lost if the server is overloaded. If the value is too large, then the packets might be delayed.

Information Value
Data type String
Default 1024000


receiveBufferSizeChannel

Value, in bytes, for the maximum size of an incoming UDP packet, which is the size of the receive buffer that is allocated by the UDP channel.

Information Value
Data type String
Default 65535


Related tasks

  • Browse all SIP topics