outgoing-message-handler (cache)

outgoing-message-handler

Used in: acceptor-config, initiator-config.

Description

The outgoing-message-handler specifies the configuration info used to detect dropped client-to-cluster connections. For connection initiators and acceptors that use connectionless protocols (e.g. JMS), this information is necessary to proactively detect and release resources allocated to dropped connections. Connection-oriented initiators and acceptors can also use this information as an additional mechanism to detect dropped connections.

Elements

The following table describes the elements you can define within the outgoing-message-handler element.

Element Required/Optional Description
<heartbeat-interval> Optional Specifies the interval between ping requests. A ping request is used to ensure the integrity of a connection.

The value of this element must be in the following format:
[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

  • MS or ms (milliseconds)
  • S or s (seconds)
  • M or m (minutes)
  • H or h (hours)
  • D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed.

A value of zero disables ping requests.

The default value is zero.

<heartbeat-timeout> Optional Specifies the maximum amount of time to wait for a response to a ping request before declaring the underlying connection unusable.

The value of this element must be in the following format:
[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

  • MS or ms (milliseconds)
  • S or s (seconds)
  • M or m (minutes)
  • H or h (hours)
  • D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed.

The default value is the value of the request-timeout element.

<request-timeout> Optional Specifies the maximum amount of time to wait for a response message before declaring the underlying connection unusable.

The value of this element must be in the following format:
[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

  • MS or ms (milliseconds)
  • S or s (seconds)
  • M or m (minutes)
  • H or h (hours)
  • D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed.

The default value is an infinite timeout.