CHANNELS stanza of the client configuration file

Use the CHANNELS stanza to specify information about client channels.

Note: The description of each attribute of this stanza indicates which IBM MQ clients can read that attribute. For a summary table for all IBM MQ MQI client configuration file stanzas, see Which IBM MQ attributes can be read by each client. The following attributes can be included in the CHANNELS stanza:

    CCSID = number
    The coded character set number to be used.

    This attribute can be read by C, unmanaged .NET, managed .NET, and managed XMS .NET clients.

    The CCSID number is equivalent to the MQCCSID environment variable.

    ChannelDefinitionDirectory = path
    The directory path to the file containing the client channel definition table.

    This attribute can be read by C, unmanaged .NET, managed .NET, and managed XMS .NET clients.

    On Windows systems, the default is the IBM MQ data and log files directory, typically C:\ProgramData\IBM\MQ.

    On UNIX and Linux systems, the default is /var/mqm.

    ChannelDefinitionDirectory can contain a URL which works in combination with the ChannelDefinitionFile attribute (see URL access to the CCDT).

    The ChannelDefinitionDirectory path is equivalent to the MQCHLLIB environment variable.

    ChannelDefinitionFile = filename|AMQCLCHL.TAB
    The name of the file containing the client channel definition table.

    This attribute can be read by C, unmanaged .NET, managed .NET, and managed XMS .NET clients.

    The client channel definition table is equivalent to the MQCHLTAB environment variable.

    ReconDelay = (delay[,rand]) (delay[,rand])...
    The ReconDelay attribute provides an administrative option to configure reconnect delay for client programs that can auto-reconnect.

    This attribute can be read by C, unmanaged .NET, IBM MQ classes for JMS, managed .NET, and managed XMS .NET clients.

    Here is an example configuration: 
    ReconDelay=(1000,200)(2000,200)(4000,1000)
    The example shown defines an initial delay of one second, plus a random interval of up to 200 milliseconds. The next delay is two seconds plus a random interval of up to 200 milliseconds. All subsequent delays are four seconds, plus a random interval of up to 1000 milliseconds.

    DefRecon = NO|YES|QMGR |DISABLED
    The DefRecon attribute provides an administrative option to enable client programs to automatically reconnect, or to disable the automatic reconnection of a client program that has been written to reconnect automatically. We might opt to set the latter if a program uses an option, such as MQPMO_LOGICAL_ORDER, that is incompatible with reconnection.

    This attribute can be read by C, unmanaged .NET, IBM MQ classes for JMS, managed .NET, and managed XMS .NET clients.

    Automatic client reconnection is not supported by IBM MQ classes for Java.

    The interpretation of the DefRecon options depends on whether an MQCNO_RECONNECT_* value is also set in the client program, and what value is set.
    If the client program connects using MQCONN, or sets the MQCNO_RECONNECT_AS_DEF option using MQCONNX, the reconnect value set by DefRecon takes effect. If no reconnect value is set in the program, or by the DefRecon option, the client program is not reconnected automatically.

      NO
      Unless overridden by MQCONNX, the client is not reconnected automatically.

      YES
      Unless overridden by MQCONNX, the client reconnects automatically.

      QMGR
      Unless overridden by MQCONNX, the client reconnects automatically, but only to the same queue manager. The QMGR option has the same effect as MQCNO_RECONNECT_Q_MGR.

      DISABLED
      Reconnection is disabled, even if requested by the client program using the MQCONNX MQI call.

    The automatic client reconnection depends on two values:

    • The reconnect option set in the application
    • DefRecon value in the mqclient.ini file

    DefRecon value in the mqclient.ini Reconnection options set in the application
      MQCNO_RECONNECT MQCNO_RECONNECT_Q_MGR MQCNO_RECONNECT_AS_DEF MQCNO_RECONNECT_DISABLED
    NO YES QMGR NO NO
    YES YES QMGR YES NO
    QMGR YES QMGR QMGR NO
    DISABLED NO NO NO NO

    MQReconnectTimeout
    The timeout in seconds to reconnect to a client. The default value is 1800 seconds (30 minutes).

    This attribute can be read by C and unmanaged .NET clients, and managed .NET clients.

    IBM MQ classes for JMS clients can specify a timeout to reconnect using the connection factory property CLIENTRECONNECTTIMEOUT. The default value for this property is 1800 seconds (30 minutes).

    IBM MQ classes for XMS .NET clients can specify a timeout to reconnect using the following properties:

    • The connection factory property CLIENTRECONNECTTIMEOUT. The default value for this property is 1800 seconds (30 minutes). This property is valid only for Managed mode.
    • The property XMSC.WMQ_CLIENT_RECONNECT_TIMEOUT. The default value for this property is 1800 seconds (30 minutes). This property is valid only for Managed mode.

    ServerConnectionParms
    ServerConnectionParms is equivalent to the MQSERVER environment variable and specifies the location of the IBM MQ server and the communication method to be used.

    This attribute can be read by C, unmanaged .NET, managed .NET, and managed XMS .NET clients.

    The ServerConnectionParms attribute defines only a simple channel; we cannot use it to define a TLS channel or a channel with channel exits. It is a string of the format ChannelName/TransportType/ConnectionName, ConnectionName must be a fully qualified network name. ChannelName cannot contain the forward slash (/) character because this character is used to separate the channel name, transport type, and connection name.

    When ServerConnectionParms is used to define a client channel, a maximum message length of 100 MB is used. Therefore the maximum message size in effect for the channel is the value specified in the SVRCONN channel on the server. Note that only a single client channel connection can be made. For example, if you have two entries: 
    ServerConnectionParms=R1.SVRCONN/TCP/localhost(1963)
ServerConnectionParms=R2.SVRCONN/TCP/localhost(1863)
    only the second one is used.

    Specify ConnectionName as a comma-separated list of names for the stated transport type. Generally, only one name is required. We can provide multiple hostnames to configure multiple connections with the same properties. The connections are tried in the order that they are specified in the connection list until a connection is successfully established. If no connection is successful, the client starts to process again. Connection lists are an alternative to queue manager groups to configure connections for reconnectable clients.

    Put1DefaultAlwaysSync = NO| YES
    Controls the behavior of the MQPUT1 function call with the option MQPMO_RESPONSE_AS_Q_DEF.

    This attribute can be read by C, unmanaged .NET, IBM MQ classes for Java, IBM MQ classes for JMS, managed .NET, and managed XMS .NET clients.

      NO
      If MQPUT1 is set with MQPMO_SYNCPOINT, it behaves as MQPMO_ASYNC_RESPONSE. Similarly, if MQPUT1 is set with MQPMO_NO_SYNCPOINT, it behaves as MQPMO_SYNC_RESPONSE. This is the default value.

      YES
      MQPUT1 behaves as if MQPMO_SYNC_RESPONSE is set, regardless of whether MQPMO_SYNCPOINT or MQPMO_NO_SYNCPOINT is set.

    PasswordProtection = Compatible|always|optional
    From IBM MQ Version 8.0, allows you to set protected passwords in the MQCSP structure, rather than using TLS.

    This attribute can be read by C, unmanaged .NET, IBM MQ classes for Java, IBM MQ classes for JMS, managed .NET, and managed XMS .NET clients.

    MQCSP password protection is useful for test and development purposes as using MQCSP password protection is simpler than setting up TLS encryption, but not as secure.

    See MQCSP password protection for further information.

Parent topic: Configure a client using a configuration file


Related information