Real-timeInput node

This topic contains the following sections:

Purpose

Use the Real-timeInput node to receive messages, from clients that connect to the broker using the WebSphere MQ Real-time Transport or the WebSphere MQ Multicast Transport and that use JMS application programming interfaces, into a message flow.

An output node in a message flow that starts with a Real-timeInput node can be any of the supported output nodes, including user-defined output nodes. You can create a message flow that receives messages from real-time clients and generates messages for clients that use all supported transports to connect to the broker, because you can configure the message flow to request the broker to provide any conversion that is necessary.

If you are create a message flow to use as a subflow, you cannot use a standard input node: you must use an instance of the Input node as the first node to create an in terminal for the subflow.

If your message flow does not receive messages from JMS applications, you can choose one of the supported input nodes.

The Real-timeInput node is represented in the workbench by the following icon:

Real-timeInput node icon

Using this node in a message flow

For an example of how to use this node, assume that you have written a publishing application that publishes stock updates on a regular basis. The application sends the messages to the broker on a Real-timeInput node, and the message flow makes the publications available to multiple subscribers through a Publication node.

Configuring the Real-timeInput node

When you have put an instance of the Real-timeInput node into a message flow, you can configure it. Right-click the node in the editor view and select Properties. The node's basic properties are displayed.

All mandatory properties for which you must enter a value (those that do not have a default value defined) are marked with an asterisk on the properties dialog.

Configure the Real-timeInput node as follows:

  1. In Port, identify the number of the port on which the node listens for messages from JMS applications. Ensure that the port number that you specify does not conflict with any other listener service. There is no default for this property; you must enter a value.
  2. If you want to authenticate users that send messages on receipt of their messages, select the Authentication check box. If you clear the check box (the default setting), users are not authenticated.
  3. If you want clients to use HTTP tunneling, select the Tunnel through HTTP check box. If you clear the check box (the default setting), messages do not use HTTP tunneling. If you set this option, all client applications that connect must use this feature. If they do not, their connection is rejected. The client application cannot use this option in conjunction with the connect-via proxy setting, which is activated from the client side.
  4. In Read Threads, enter the number of threads that you want the broker to allocate to read messages. The broker starts as many instances of the message flow as are necessary to process current messages, up to this limit. The default setting is 10.
  5. In Write Threads, enter the number of threads that you want the broker to allocate to write messages. The broker starts as many instances of the message flow as are necessary to process current messages, up to this limit. The default setting is 10.
  6. In Authentication Threads, enter the number of threads that you want the broker to allocate to user authentication checks. The user authentication check is performed when a message is received. The broker starts as many instances of the message flow as are necessary to process current messages, up to this limit. The default setting is 10.
  7. Select Description in the properties dialog navigator to enter a short description, a long description, or both.
  8. Click Apply to make the changes to the Real-timeInput node without closing the properties dialog. Click OK to apply the changes and close the properties dialog.

    Click Cancel to close the dialog and discard all the changes that you have made to the properties.

Connecting the terminals

The Real-timeInput node routes each message that it retrieves successfully to the out terminal. If this fails, the message is retried.

Terminals and properties

The Real-timeInput node terminals are described in the following table.

Terminal Description
Out The output terminal to which the message is routed if it is successfully retrieved from JMS.

The following tables describe the node properties; the column headed M indicates whether the property is mandatory (marked with an asterisk on the properties dialog if you must enter a value when no default is defined), the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the bar file to deploy it).

The Real-timeInput node Basic properties are described in the following table.

Property M C Default Description
Port Yes Yes 0 The port number on which the input node listens for publish or subscribe requests.
Authentication Yes No Cleared Select the check box to authenticate users.
Tunnel through HTTP Yes No Cleared Select the check box to indicate that users use HTTP tunneling. Clear the check box to indicate that HTTP tunneling is not used.
Read Threads No Yes 10 The number of threads used for reading.
Write Threads No Yes 10 The number of threads used for writing.
Authentication Threads No Yes 10 The number of threads used for accepting connections and authenticating users.

The properties of the General Message Options for the Real-timeInput node are described in the following table.

The Real-timeInput node Description properties are described in the following table.

Property M C Default Description
Short Description No No   A brief description of the node.
Long Description No No   Text that describes the purpose of the node in the message flow.