Configuration Guide

Unicast Immediate Messaging Network Options

In early versions of UM, the Unicast Immediate Messaging (UIM) feature was primarily used to support the Request/Response feature. Therefore, the configuration options related to UIMs have names that start with "request" and "response". However, as UM has evolved, the UIM feature has come to be used by a great many UM features, such as Late Join, Persistence, and Queuing.

To maintain backwards compatibility, the old names of the configuration options have been retained. The reader must simply be aware that the "request_..." and "response_..." options affect more than just the request/response feature.

See Unicast Immediate Messaging for general information on UIM. See also Unicast Immediate Messaging Operation Options for operationally-oriented options.

# Reference <-

## request_tcp_bind_request_port (context) <-

  Allows you to turn off UIM port binding (also known as "request port binding").

  Setting this option to 0 prevents sockets from being bound to the UIM port. Turning off UIM port binding also turns off several UM features such as: Request/Response Model, Using Late Join, Off-Transport Recovery (OTR), the reception of Unicast Immediate Messages, persistence, brokered queuing, and ULB.

  See Unicast Immediate Messaging for general information on UIM.

  Scope: | context
  Type: | int
  Default value: | 1
  When to Set: | Can only be set during object initialization.
  Version: | This option was implemented in LBM 3.3.7/UME 2.0.5.

  Value | Description
  --- | ---
  1 | Set UIM port binding. Default for all.
  0 | Turn off UIM port binding.

## request_tcp_interface (context) <-

  Specifies the network interface over which UM accepts TCP connections for reception of UIM messages.

  You can specify a full IP address of interface, or just the network part (see Specifying Interfaces for details).

  Default is set to default_interface (context), if specified. Otherwise, it is set to INADDR_ANY, meaning that it will not bind to a specific interface. You can also set this option to 0.0.0.0/0 which produces the same result.

  See Unicast Immediate Messaging for general information on UIM.

  Note: if specifying an interface name in an XML-format file, see Interface Device Names and XML.

  Scope: | context
  Type: | lbm_ipv4_address_mask_t
  Default value: | 0.0.0.0 (INADDR_ANY)
  When to Set: | Can only be set during object initialization.

## request_tcp_port (context) <-

  Port number used for UIM port (also known as "request port").

  A context binds to and listens on the UIM port to be able to accept TCP connections for reception of Unicast Immediate Messages (UIMs). The port is either explicitly specified by request_tcp_port (context), or is selected from the range: [request_tcp_port_low (context), request_tcp_port_high (context)].

  If request_tcp_port (context) is 0, the context binds to the first open port within the range of [request_tcp_port_low (context), request_tcp_port_high (context)]. If nonzero, the specific port number is used instead.

  See Unicast Immediate Messaging for general information on UIM. See Port Assignments for more information about configuring ports.

  Scope: | context
  Type: | lbm_uint16_t
  Default value: | 0 (use open port)
  Byte order: | Network
  When to Set: | Can only be set during object initialization.

## request_tcp_port_high (context) <-

  High port number to use for UIM port (also known as "request port").

  A context binds to and listens on the UIM port to be able to accept TCP connections for reception of Unicast Immediate Messages (UIMs). The port is either explicitly specified by request_tcp_port (context), or is selected from the range: [request_tcp_port_low (context), request_tcp_port_high (context)].

  See Unicast Immediate Messaging for more information about UIM. See Port Assignments for more information about configuring ports.

  Scope: | context
  Type: | lbm_uint16_t
  Default value: | 14395
  Byte order: | Host
  When to Set: | Can only be set during object initialization.

## request_tcp_port_low (context) <-

  Low port number to use for UIM port (also known as "request port").

  A context binds to and listens on the UIM port to be able to accept TCP connections for reception of Unicast Immediate Messages (UIMs). The port is either explicitly specified by request_tcp_port (context), or is selected from the range: [request_tcp_port_low (context), request_tcp_port_high (context)].

  See Unicast Immediate Messaging for general information on UIM. See Port Assignments for more information about configuring ports.

  Scope: | context
  Type: | lbm_uint16_t
  Default value: | 14391
  Byte order: | Host
  When to Set: | Can only be set during object initialization.