tcp-acceptor

tcp-acceptor

Used in: acceptor-config.

Description

The tcp-initiator element specifies the configuration info for a connection acceptor that accepts connections from Coherence*Extend clients over TCP/IP.

For additional details and example configurations see Configuring and Using Coherence*Extend.

Elements

The following table describes the elements you can define within the tcp-acceptor element.

Element Required/Optional Description
<local-address> Required Specifies the local address (IP or DNS name) and port that the TCP/IP ServerSocket opened by the connection acceptor will listen on.

For example, the following will instruct the connection acceptor to bind the TCP/IP ServerSocket to 192.168.0.2:9099:

<local-address>
  <address>192.168.0.2</address>
  <port>9099</port>
  <reusable>true</reusable>
</local-address>


The <reusable> child element specifies whether or not a TCP/IP socket can be bound to an address if a previous connnection is in a timeout state.

When a TCP/IP connection is closed the connection may remain in a timeout state for a period of time after the connection is closed (typically known as the TIME_WAIT state or 2MSL wait state). For applications using a well known socket address or port it may not be possible to bind a socket to a required address if there is a connection in the timeout state involving the socket address or port.

<keep-alive-enabled> Optional Indicates whether or not keep alive (SO_KEEPALIVE) is enabled on a TCP/IP socket.

Valid values are true and false.

Keep alive is enabled by default.
<tcp-delay-enabled> Optional Indicates whether or not TCP delay (Nagle's algorithm) is enabled on a TCP/IP socket.

Valid values are true and false.

TCP delay is disabled by default.
<receive-buffer-size> Optional Configures the size of the underlying TCP/IP socket network receive buffer.

Increasing the receive buffer size can increase the performance of network I/O for high-volume connections, while decreasing it can help reduce the backlog of incoming data.

The value of this element must be in the following format:
[\d]+[[.][\d]+]?[K|k|M|m|G|g]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

  • K or k (kilo, 210)
  • M or m (mega, 220)
  • G or g (giga, 230)

If the value does not contain a factor, a factor of one is assumed.

Default value is O/S dependent.

<send-buffer-size> Optional Configures the size of the underlying TCP/IP socket network send buffer.

The value of this element must be in the following format:
[\d]+[[.][\d]+]?[K|k|M|m|G|g]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

  • K or k (kilo, 210)
  • M or m (mega, 220)
  • G or g (giga, 230)

If the value does not contain a factor, a factor of one is assumed.

Default value is O/S dependent.

<listen-backlog> Optional Configures the size of the TCP/IP server socket backlog queue.

Valid values are positive integers.

Default value is O/S dependent.
<linger-timeout> Optional Enables SO_LINGER on a TCP/IP socket with the specified linger time.

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.

Linger is disabled by default.