ImqQueueManager C++ class

This class encapsulates a queue manager (an IBM MQ object of type MQOT_Q_MGR).

Figure 1. ImqQueueManager class

This class relates to the MQI calls listed in ImqQueueManager cross-reference. Not all the listed methods are applicable to all platforms; see ALTER QMGR for more details.


Class attributes

    behavior
    Controls the behavior of implicit connection and disconnection.

      IMQ_EXPL_DISC_BACKOUT (0L)
      An explicit call to the disconnect method implies backout. This attribute is mutually exclusive with IMQ_EXPL_DISC_COMMIT.

      IMQ_EXPL_DISC_COMMIT (1L)
      An explicit call to the disconnect method implies commit (the default). This attribute is mutually exclusive with IMQ_EXPL_DISC_BACKOUT.

      IMQ_IMPL_CONN (2L)
      Implicit connection is allowed (the default).

      IMQ_IMPL_DISC_BACKOUT (0L)
      An implicit call to the disconnect method, which can occur during object destruction, implies backout. This attribute is mutually exclusive with the IMQ_IMPL_DISC_COMMIT.

      IMQ_IMPL_DISC_COMMIT (4L)
      An implicit call to the disconnect method, which can occur during object destruction, implies commit (the default). This attribute is mutually exclusive with IMQ_IMPL_DISC_BACKOUT.

At IBM MQ V7.0 and above, C++ applications that make use of an implicit connection, need to specify IMQ_IMPL_CONN along with any other options provided in the setBehavior() method on an object of class ImqQueueManager. If the application does not use the setBehavior() method to explicitly set the behavior options, for example, 

ImqQueueManager_object.setBehavior(IMQ_IMPL_DISC_COMMIT)
this change does not affect you since MQ_IMPL_CONN is enabled by default. If the application explicitly sets the behavior options, for example, 
ImqQueueManager_object.setBehavior(IMQ_IMPL_DISC_COMMIT)
you need to include IMQ_IMPL_CONN in the setBehavior() method as follows, to allow the application to complete an implicit connection: 
ImqQueueManager_object.setBehavior(IMQ_IMPL_CONN | IMQ_IMPL_DISC_COMMIT)


Object attributes

    accounting connections override
    Allows applications to override the setting of the MQI accounting and queue accounting values.This attribute is read-only.

    accounting interval
    How long before intermediate accounting records are written (in seconds). This attribute is read-only.

    activity recording
    Controls the generation of activity reports. This attribute is read-only.

    adopt new mca check
    The elements checked to determine if an MCA should be adopted when a new inbound channel is detected that has the same name as an MCA that is already active. This attribute is read-only.

    adopt new mca type
    Whether an orphaned instance of an MCA of a particular channel type should be restarted automatically when a new inbound channel request matching the adopt new mca check parameters is detected. This attribute is read-only.

    authentication type
    Indicates the type of authentication which is being performed.

    authority event
    Controls authority events. This attribute is read-only.

    begin options
    Options that apply to the begin method. The initial value is MQBO_NONE.

    bridge event
    Whether IMS bridge events are generated. This attribute is read-only.

    channel auto definition
    Channel auto definition value. This attribute is read-only.

    channel auto definition event
    Channel auto definition event value. This attribute is read-only.

    channel auto definition exit
    Channel auto definition exit name. This attribute is read-only.

    channel event
    Whether channel events are generated. This attribute is read-only.

    channel initiator adapters
    The number of adapter subtasks to use for processing IBM MQ calls. This attribute is read-only.

    channel initiator control
    Whether the Channel Initiator should be started automatically when the Queue Manager is started. This attribute is read-only.

    channel initiator dispatchers
    The number of dispatchers to use for the channel initiator. This attribute is read-only.

    channel initiator trace autostart
    Whether channel initiator trace should start automatically or not. This attribute is read-only.

    channel initiator trace table size
    The size of the channel initiator's trace data space (in MB). This attribute is read-only.

    channel monitoring
    Controls the collection of online monitoring data for channels. This attribute is read-only.

    channel reference
    A reference to a channel definition for use during client connection. While connected, this attribute can be set to null, but cannot be changed to any other value. The initial value is null.

    channel statistics
    Controls the collection of statistics data for channels. This attribute is read-only.

    character set
    Coded character set identifier (CCSID). This attribute is read-only.

    cluster sender monitoring
    Controls the collection of online monitoring data for automatically-defined cluster sender channels. This attribute is read-only.

    cluster sender statistics
    Controls the collection of statistics data for automatically defined cluster sender channels. This attribute is read-only.

    cluster workload data
    Cluster workload exit data. This attribute is read-only.

    cluster workload exit
    Cluster workload exit name. This attribute is read-only.

    cluster workload length
    Cluster workload length. This attribute is read-only.

    cluster workload mru
    Cluster workload most recently used channels value. This attribute is read-only.

    cluster workload use queue
    Cluster workload use queue value. This attribute is read-only.

    command event
    Whether command events are generated. This attribute is read-only.

    command input queue name
    System command input queue name. This attribute is read-only.

    command level
    Command level supported by the queue manager. This attribute is read-only.

    command server control
    Whether the Command Server should be started automatically when the Queue Manager is started. This attribute is read-only.

    connect options
    Options that apply to the connect method. The initial value is MQCNO_NONE. The following additional values may be possible, depending on platform:

    • MQCNO_STANDARD_BINDING
    • MQCNO_FASTPATH_BINDING
    • MQCNO_HANDLE_SHARE_NONE
    • MQCNO_HANDLE_SHARE_BLOCK
    • MQCNO_HANDLE_SHARE_NO_BLOCK
    • MQCNO_SERIALIZE_CONN_TAG_Q_MGR
    • MQCNO_SERIALIZE_CONN_TAG_QSG
    • MQCNO_RESTRICT_CONN_TAG_Q_MGR
    • MQCNO_RESTRICT_CONN_TAG_QSG

    connection id
    A unique identifier that allows MQ to reliably identify an application.

    connection status
    TRUE when connected to the queue manager. This attribute is read-only.

    connection tag
    A tag to be associated with a connection. This attribute can only be set when not connected. The initial value is null.

    cryptographic hardware
    Configuration details for cryptographic hardware. For MQ MQI client connections.

    dead-letter queue name
    Name of the dead-letter queue. This attribute is read-only.

    default transmission queue name
    Default transmission queue name. This attribute is read-only.

    distribution lists
    Capability of the queue manager to support distribution lists.

    dns group
    The name of the group that the TCP listener that handles inbound transmissions for the queue sharing group should join when using Workload Manager Dynamic Domain Name Services support. This attribute is read-only.

    dns wlm
    Whether the TCP listener that handles inbound transmissions for the queue sharing group should register with Workload Manager for Dynamic Domain Name Services. This attribute is read-only.

    first authentication record
    The first of one or more objects of class ImqAuthenticationRecord, in no particular order, in which the ImqAuthenticationRecord connection reference addresses this object. For MQ MQI client connections.

    first managed object
    The first of one or more objects of class ImqObject, in no particular order, in which the ImqObject connection reference addresses this object. The initial value is zero.

    inhibit event
    Controls inhibit events. This attribute is read-only.

    ip address version
    Which IP protocol (IPv4 or IPv6) to use for a channel connection. This attribute is read-only.

    key repository
    Location of the key database file in which keys and certificates are stored. For IBM MQ MQI client connections.

    key reset count
    The number of unencrypted bytes sent and received within a TLS conversation before the secret key is renegotiated. This attribute applies only to client connections using MQCONNX. See also ssl key reset count.

    listener timer
    The time interval (in seconds) between attempts by IBM MQ to restart the listener if there has been an APPC or TCP/IP failure. This attribute is read-only.

    local event
    Controls local events. This attribute is read-only.

    logger event
    Controls whether recovery log events are generated. This attribute is read-only.

    lu group name
    The generic LU name that the LU 6.2 listener that handles inbound transmissions for the queue sharing group should use. This attribute is read-only.

    lu name
    The name of the LU to use for outbound LU 6.2 transmissions. This attribute is read-only.

    lu62 arm suffix
    The suffix of the SYS1.PARMLIB member APPCPMxx, that nominates the LUADD for this channel initiator. This attribute is read-only.

    lu62 channels
    The maximum number of channels that can be current or clients that can be connected, that use the LU 6.2 transmission protocol. This attribute is read-only.

    maximum active channels
    The maximum number of channels that can be active at any time. This attribute is read-only.

    maximum channels
    The maximum number of channels that can be current (including server-connection channels with connected clients). This attribute is read-only.

    maximum handles
    Maximum number of handles. This attribute is read-only.

    maximum message length
    Maximum possible length for any message on any queue managed by this queue manager. This attribute is read-only.

    maximum priority
    Maximum message priority. This attribute is read-only.

    maximum uncommitted messages
    Maximum number of uncommitted messages within a unit or work. This attribute is read-only.

    mqi accounting
    Controls the collection of accounting information for MQI data. This attribute is read-only.

    mqi statistics
    Controls the collection of statistics monitoring information for the queue manager. This attribute is read-only.

    outbound port maximum
    The higher end of the range of port numbers to be used when binding outgoing channels. This attribute is read-only.

    outbound port minimum
    The lower end of the range of port numbers to be used when binding outgoing channels. This attribute is read-only.

    password
    password associated with user ID

    performance event
    Controls performance events. This attribute is read-only.

    platform
    Platform on which the queue manager resides. This attribute is read-only.

    queue accounting
    Controls the collection of accounting information for queues. This attribute is read-only.

    queue monitoring
    Controls the collection of online monitoring data for queues. This attribute is read-only.

    queue statistics
    Controls the collection of statistics data for queues. This attribute is read-only.

    receive timeout
    Approximately how long a TCP/IP message channel will wait to receive data, including heartbeats, from its partner, before returning to the inactive state. This attribute is read-only.

    receive timeout minimum
    The minimum time that a TCP/IP channel will wait to receive data, including heartbeats, from its partner, before returning to the inactive state. This attribute is read-only.

    receive timeout type
    A qualifier applied to receive timeout. This attribute is read-only.

    remote event
    Controls remote events. This attribute is read-only.

    repository name
    Repository name. This attribute is read-only.

    repository namelist
    Repository namelist name. This attribute is read-only.

    shared queue manager name
    Whether MQOPENs of a shared queue where the ObjectQMgrName is another queue manager in the queue sharing group should resolve to an open of the shared queue on the local queue manager. This attribute is read-only.

    ssl event
    Whether SSL events are generated. This attribute is read-only.

    ssl FIPS required
    Whether only FIPS-certified algorithms should be used if the cryptography is executed in IBM MQ software. This attribute is read-only.

    ssl key reset count
    The number of unencrypted bytes sent and received within an SSL conversation before the secret key is renegotiated. This attribute is read-only.

    start-stop event
    Controls start-stop events. This attribute is read-only.

    statistics interval
    How often statistics monitoring data is written to the monitoring queue. This attribute is read-only.

    syncpoint availability
    Availability of syncpoint participation. This attribute is read-only. Note: Queue manager-coordinated global units of work are not supported on the IBM i platform. We can program a unit of work, externally coordinated by IBM i, using the _Rcommit and _Rback native system calls. Start this type of unit of work by starting the IBM MQ application under job-level commitment control using the STRCMTCTL command. See Interfaces to the IBM i external syncpoint manager for further details. Backout and commit are supported on the IBM i platform for local units of work coordinated by a queue manager.

    tcp channels
    The maximum number of channels that can be current or clients that can be connected, that use the TCP/IP transmission protocol. This attribute is read-only.

    tcp keepalive
    Whether the TCP KEEPALIVE facility is to be used to check that the other end of the connection is still available. This attribute is read-only.

    tcp name
    The name of either the sole or default TCP/IP system to be used, depending on the value of tcp stack type. This attribute is read-only.

    tcp stack type
    Whether the channel initiator is permitted to only use the TCP/IP address space specified in tcp name or can bind to any selected TCP/IP address. This attribute is read-only.

    trace route recording
    Controls the recording of route tracing information. This attribute is read-only.

    trigger interval
    Trigger interval. This attribute is read-only.

    user id
    On UNIX and Linux platforms, the application's real user ID. On Windows platforms, the application's user ID.


Constructors

    ImqQueueManager( );
    The default constructor.

    ImqQueueManager( const ImqQueueManager & manager );
    The copy constructor. The connection status will be FALSE.

    ImqQueueManager( const char * name );
    Sets the ImqObject name to name.


Destructors

When an ImqQueueManager object is destroyed, it is automatically disconnected.


Class methods (public)

    static MQLONG behavior( );
    Returns the behavior.

    void setBehavior( const MQLONG behavior = 0 );
    Sets the behavior.


Object methods (public)

    void operator = ( const ImqQueueManager & mgr );
    Disconnects if necessary, and copies instance data from mgr. The connection status is be FALSE.

    ImqBoolean accountingConnOverride ( MQLONG & statint );
    Provides a copy of the accounting connections override value. It returns TRUE if successful.

    MQLONG accountingConnOverride ( );
    Returns the accounting connections override value without any indication of possible errors.

    ImqBoolean accountingInterval ( MQLONG & statint );
    Provides a copy of the accounting interval value. It returns TRUE if successful.

    MQLONG accountingInterval ( );
    Returns the accounting interval value without any indication of possible errors.

    ImqBoolean activityRecording ( MQLONG & rec );
    Provides a copy of the activity recording value. It returns TRUE if successful.

    MQLONG activityRecording ( );
    Returns the activity recording value without any indication of possible errors.

    ImqBoolean adoptNewMCACheck ( MQLONG & check );
    Provides a copy of the adopt new MCA check value. It returns TRUE if successful.

    MQLONG adoptNewMCACheck ( );
    Returns the adopt new MCA check value without any indication of possible errors.

    ImqBoolean adoptNewMCAType ( MQLONG & type );
    Provides a copy of the adopt new MCA type. It returns TRUE if successful.

    MQLONG adoptNewMCAType ( );
    Returns the adopt new MCA type without any indication of possible errors.

    QLONG authenticationType ( ) const;
    Returns the authentication type.

    void setAuthenticationType ( const MQLONG type = MQCSP_AUTH_NONE );
    Sets the authentication type.

    ImqBoolean authorityEvent( MQLONG & event );
    Provides a copy of the enablement state of the authority event. It returns TRUE if successful.

    MQLONG authorityEvent( );
    Returns the enablement state of the authority event without any indication of possible errors.

    ImqBoolean backout( );
    Backs out uncommitted changes. It returns TRUE if successful.

    ImqBoolean begin( );
    Begins a unit of work. The begin options affect the behavior of this method. It returns TRUE if successful, but it also returns TRUE even if the underlying MQBEGIN call returns MQRC_NO_EXTERNAL_PARTICIPANTS or MQRC_PARTICIPANT_NOT_AVAILABLE (which are both associated with MQCC_WARNING).

    MQLONG beginOptions( ) const ;
    Returns the begin options.

    void setBeginOptions( const MQLONG options = MQBO_NONE );
    Sets the begin options.

    ImqBoolean bridgeEvent ( MQLONG & event);
    Provides a copy of the bridge event value. It returns TRUE if successful.

    MQLONG bridgeEvent ( );
    Returns the bridge event value without any indication of possible errors.

    ImqBoolean channelAutoDefinition( MQLONG & value );
    Provides a copy of the channel auto definition value. It returns TRUE if successful.

    MQLONG channelAutoDefinition( );
    Returns the channel auto definition value without any indication of possible errors.

    ImqBoolean channelAutoDefinitionEvent( MQLONG & value );
    Provides a copy of the channel auto definition event value. It returns TRUE if successful.

    MQLONG channelAutoDefinitionEvent( );
    Returns the channel auto definition event value without any indication of possible errors.

    ImqBoolean channelAutoDefinitionExit( ImqString & name );
    Provides a copy of the channel auto definition exit name. It returns TRUE if successful.

    ImqString channelAutoDefinitionExit( );
    Returns the channel auto definition exit name without any indication of possible errors.

    ImqBoolean channelEvent ( MQLONG & event);
    Provides a copy of the channel event value. It returns TRUE if successful.

    MQLONG channelEvent( );
    Returns the channel event value without any indication of possible errors.

    MQLONG channelInitiatorAdapters ( );
    Returns the channel initiator adapters value without any indication of possible errors.

    ImqBoolean channelInitiatorAdapters ( MQLONG & adapters );
    Provides a copy of the channel initiator adapters value. It returns TRUE if successful.

    MQLONG channelInitiatorControl ( );
    Returns the channel initiator startup value without any indication of possible errors.

    ImqBoolean channelInitiatorControl ( MQLONG & init );
    Provides a copy of the channel initiator control startup value. It returns TRUE if successful.

    MQLONG channelInitiatorDispatchers ( );
    Returns the channel initiator dispatchers value without any indication of possible errors.

    ImqBoolean channelInitiatorDispatchers ( MQLONG & dispatchers );
    Provides a copy of the channel initiator dispatchers value. It returns TRUE if successful.

    MQLONG channelInitiatorTraceAutoStart ( );
    Returns the channel initiator trace auto start value without any indication of possible errors.

    ImqBoolean channelInitiatorTraceAutoStart ( MQLONG & auto);
    Provides a copy of the channel initiator trace auto start value. It returns TRUE if successful.

    MQLONG channelInitiatorTraceTableSize ( );
    Returns the channel initiator trace table size value without any indication of possible errors.

    ImqBoolean channelInitiatorTraceTableSize ( MQLONG & size);
    Provides a copy of the channel initiator trace table size value. It returns TRUE if successful.

    ImqBoolean channelMonitoring ( MQLONG & monchl );
    Provides a copy of the channel monitoring value. It returns TRUE if successful.

    MQLONG channelMonitoring ( );
    Returns the channel monitoring value without any indication of possible errors.

    ImqBoolean channelReference( ImqChannel * & pchannel );
    Provides a copy of the channel reference. If the channel reference is invalid, sets pchannel to null. This method returns TRUE if successful.

    ImqChannel * channelReference( );
    Returns the channel reference without any indication of possible errors.

    ImqBoolean setChannelReference( ImqChannel & channel );
    Sets the channel reference. This method returns TRUE if successful.

    ImqBoolean setChannelReference( ImqChannel * channel = 0 );
    Sets or resets the channel reference. This method returns TRUE if successful.

    ImqBoolean channelStatistics ( MQLONG & statchl );
    Provides a copy of the channel statistics value. It returns TRUE if successful.

    MQLONG channelStatistics ( );
    Returns the channel statistics value without any indication of possible errors.

    ImqBoolean characterSet( MQLONG & ccsid );
    Provides a copy of the character set. It returns TRUE if successful.

    MQLONG characterSet( );
    Returns a copy of the character set, without any indication of possible errors.

    MQLONG clientSslKeyResetCount ( ) const;
    Returns the SSL key reset count value used on client connections.

    void setClientSslKeyResetCount( const MQLONG count );
    Sets the SSL key reset count used on client connections.

    ImqBoolean clusterSenderMonitoring ( MQLONG & monacls );
    Provides a copy of the cluster sender monitoring default value. It returns TRUE if successful.

    MQLONG clusterSenderMonitoring ( );
    Returns the cluster sender monitoring default value without any indication of possible errors.

    ImqBoolean clusterSenderStatistics ( MQLONG & statacls );
    Provides a copy of the cluster sender statistics value. It returns TRUE if successful.

    MQLONG clusterSenderStatistics ( );
    Returns the cluster sender statistics value without any indication of possible errors.

    ImqBoolean clusterWorkloadData( ImqString & data );
    Provides a copy of the cluster workload exit data. It returns TRUE if successful.

    ImqString clusterWorkloadData( );
    Returns the cluster workload exit data without any indication of possible errors.

    ImqBoolean clusterWorkloadExit( ImqString & name );
    Provides a copy of the cluster workload exit name. It returns TRUE if successful.

    ImqString clusterWorkloadExit( );
    Returns the cluster workload exit name without any indication of possible errors.

    ImqBoolean clusterWorkloadLength( MQLONG & length );
    Provides a copy of the cluster workload length. It returns TRUE if successful.

    MQLONG clusterWorkloadLength( );
    Returns the cluster workload length without any indication of possible errors.

    ImqBoolean clusterWorkLoadMRU ( MQLONG & mru );
    Provides a copy of the cluster workload most recently used channels value. It returns TRUE if successful.

    MQLONG clusterWorkLoadMRU ( );
    Returns the cluster workload most recently used channels value without any indication of possible errors.

    ImqBoolean clusterWorkLoadUseQ ( MQLONG & useq );
    Provides a copy of the cluster workload use queue value. It returns TRUE if successful.

    MQLONG clusterWorkLoadUseQ ( );
    Returns the cluster workload use queue value without any indication of possible errors.

    ImqBoolean commandEvent ( MQLONG & event );
    Provides a copy of the command event value. It returns TRUE if successful.

    MQLONG commandEvent ( );
    Returns the command event value without any indication of possible errors.

    ImqBoolean commandInputQueueName( ImqString & name );
    Provides a copy of the command input queue name. It returns TRUE if successful.

    ImqString commandInputQueueName( );
    Returns the command input queue name without any indication of possible errors.

    ImqBoolean commandLevel( MQLONG & level );
    Provides a copy of the command level. It returns TRUE if successful.

    MQLONG commandLevel( );
    Returns the command level without any indication of possible errors.

    MQLONG commandServerControl ( );
    Returns the command server startup value without any indication of possible errors.

    ImqBoolean commandServerControl ( MQLONG & server );
    Provides a copy of the command server control startup value. It returns TRUE if successful.

    ImqBoolean commit( );
    Commits uncommitted changes. It returns TRUE if successful.

    ImqBoolean connect( );
    Connects to the queue manager with the given ImqObject name, the default being the local queue manager. To connect to a specific queue manager, use the ImqObject setName method before connection. If there is a channel reference, it is used to pass information about the channel definition to MQCONNX in an MQCD. The ChannelType in the MQCD is set to MQCHT_CLNTCONN. channel reference information, which is only meaningful for client connections, is ignored for server connections. The connect options affect the behavior of this method. This method sets the connection status to TRUE if successful. It returns the new connection status.

    If there is a first authentication record, the chain of authentication records is used to authenticate digital certificates for secure client channels.

    We can connect more than one ImqQueueManager object to the same queue manager. All use the same MQHCONN connection handle and share UOW functionality for the connection associated with the thread. The first ImqQueueManager to connect obtains the MQHCONN handle. The last ImqQueueManager to disconnect performs the MQDISC.

    For a multithreaded program, it is recommended that a separate ImqQueueManager object is used for each thread.

    ImqBinary connectionId ( ) const ;
    Returns the connection ID.

    ImqBinary connectionTag ( ) const ;
    Returns the connection tag.

    ImqBoolean setConnectionTag ( const MQBYTE128 tag = 0 );
    Sets the connection tag. If tag is zero, clears the connection tag. This method returns TRUE if successful.

    ImqBoolean setConnectionTag ( const ImqBinary & tag );
    Sets the connection tag. The data length of tag must be either zero (to clear the connection tag ) or MQ_CONN_TAG_LENGTH. This method returns TRUE if successful.

    MQLONG connectOptions( ) const ;
    Returns the connect options.

    void setConnectOptions( const MQLONG options = MQCNO_NONE );
    Sets the connect options.

    ImqBoolean connectionStatus( ) const ;
    Returns the connection status.

    ImqString cryptographicHardware ( );
    Returns the cryptographic hardware.

    ImqBoolean setCryptographicHardware ( const char * hardware = 0 );
    Sets the cryptographic hardware. This method returns TRUE if successful.

    ImqBoolean deadLetterQueueName( ImqString & name );
    Provides a copy of the dead-letter queue name. It returns TRUE if successful.

    ImqString deadLetterQueueName( );
    Returns a copy of the dead-letter queue name, without any indication of possible errors.

    ImqBoolean defaultTransmissionQueueName( ImqString & name );
    Provides a copy of the default transmission queue name. It returns TRUE if successful.

    ImqString defaultTransmissionQueueName( );
    Returns the default transmission queue name without any indication of possible errors.

    ImqBoolean disconnect( );
    Disconnects from the queue manager and sets the connection status to FALSE. Closes all ImqProcess and ImqQueue objects associated with this object, and severs their connection reference before disconnection. If more than one ImqQueueManager object is connected to the same queue manager, only the last to disconnect performs a physical disconnection; others perform a logical disconnection. Uncommitted changes are committed on physical disconnection only.

    This method returns TRUE if successful. If it is called when there is no existing connection, the return code is also true.

    ImqBoolean distributionLists( MQLONG & support );
    Provides a copy of the distribution lists value. It returns TRUE if successful.

    MQLONG distributionLists( );
    Returns the distribution lists value without any indication of possible errors.

    ImqBoolean dnsGroup ( ImqString & group );
    Provides a copy of the DNS group name. It returns TRUE if successful.

    ImqString dnsGroup ( );
    Returns the DNS group name without any indication of possible errors.

    ImqBoolean dnsWlm ( MQLONG & wlm );
    Provides a copy of the DNS WLM value. It returns TRUE if successful.

    MQLONG dnsWlm ( );
    Returns the DNS WLM value without any indication of possible errors.

    ImqAuthenticationRecord * firstAuthenticationRecord ( ) const ;
    Returns the first authentication record.

    void setFirstAuthenticationRecord ( const ImqAuthenticationRecord * air = 0 );
    Sets the first authentication record.

    ImqObject * firstManagedObject( ) const ;
    Returns the first managed object.

    ImqBoolean inhibitEvent( MQLONG & event );
    Provides a copy of the enablement state of the inhibit event. It returns TRUE if successful.

    MQLONG inhibitEvent( );
    Returns the enablement state of the inhibit event without any indication of possible errors.

    ImqBoolean ipAddressVersion ( MQLONG & version );
    Provides a copy of the IP address version value. It returns TRUE if successful.

    MQLONG ipAddressVersion ( );
    Returns the IP address version value without any indication of possible errors.

    ImqBoolean keepAlive ( MQLONG & keepalive );
    Provides a copy of the keep alive value. It returns TRUE if successful.

    MQLONG keepAlive ( );
    Returns the keep alive value without any indication of possible errors.

    ImqString keyRepository ( );
    Returns the key repository.

    ImqBoolean setKeyRepository ( const char * repository = 0 );
    Sets the key repository. It returns TRUE if successful.

    ImqBoolean listenerTimer ( MQLONG & timer );
    Provides a copy of the listener timer value. It returns TRUE if successful.

    MQLONG listenerTimer ( );
    Returns the listener timer value without any indication of possible errors.

    ImqBoolean localEvent( MQLONG & event );
    Provides a copy of the enablement state of the local event. It returns TRUE if successful.

    MQLONG localEvent( );
    Returns the enablement state of the local event without any indication of possible errors.

    ImqBoolean loggerEvent ( MQLONG & count );
    Provides a copy of the logger event value. It returns TRUE if successful.

    MQLONG loggerEvent ( );
    Returns the logger event value without any indication of possible errors.

    ImqBoolean luGroupName ( ImqString & name );.
    Provides a copy of the LU group name. It returns TRUE if successful

    ImqString luGroupName ( );
    Returns the LU group name without any indication of possible errors.

    ImqBoolean lu62ARMSuffix ( ImqString & suffix );
    Provides a copy of the LU62 ARM suffix. It returns TRUE if successful.

    ImqString lu62ARMSuffix ( );
    Returns the LU62 ARM suffix without any indication of possible errors

    ImqBoolean luName ( ImqString & name );
    Provides a copy of the LU name. It returns TRUE if successful.

    ImqString luName ( );
    Returns the LU name without any indication of possible errors.

    ImqBoolean maximumActiveChannels ( MQLONG & channels);
    Provides a copy of the maximum active channels value. It returns TRUE if successful.

    MQLONG maximumActiveChannels ( );
    Returns the maximum active channels value without any indication of possible errors.

    ImqBoolean maximumCurrentChannels ( MQLONG & channels );
    Provides a copy of the maximum current channels value. It returns TRUE if successful.

    MQLONG maximumCurrentChannels ( );
    Returns the maximum current channels value without any indication of possible errors.

    ImqBoolean maximumHandles( MQLONG & number );
    Provides a copy of the maximum handles. It returns TRUE if successful.

    MQLONG maximumHandles( );
    Returns the maximum handles without any indication of possible errors.

    ImqBoolean maximumLu62Channels ( MQLONG & channels );
    Provides a copy of the maximum LU62 channels value. It returns TRUE if successful.

    MQLONG maximumLu62Channels ( );.
    Returns the maximum LU62 channels value without any indication of possible errors

    ImqBoolean maximumMessageLength( MQLONG & length );
    Provides a copy of the maximum message length. It returns TRUE if successful.

    MQLONG maximumMessageLength( );
    Returns the maximum message length without any indication of possible errors.

    ImqBoolean maximumPriority( MQLONG & priority );
    Provides a copy of the maximum priority. It returns TRUE if successful.

    MQLONG maximumPriority( );
    Returns a copy of the maximum priority, without any indication of possible errors.

    ImqBoolean maximumTcpChannels ( MQLONG & channels );
    Provides a copy of the maximum TCP channels value. It returns TRUE if successful.

    MQLONG maximumTcpChannels ( );
    Returns the maximum TCP channels value without any indication of possible errors.

    ImqBoolean maximumUncommittedMessages( MQLONG & number );
    Provides a copy of the maximum uncommitted messages. It returns TRUE if successful.

    MQLONG maximumUncommittedMessages( );
    Returns the maximum uncommitted messages without any indication of possible errors.

    ImqBoolean mqiAccounting ( MQLONG & statint );
    Provides a copy of the MQI accounting value. It returns TRUE if successful.

    MQLONG mqiAccounting ( );
    Returns the MQI accounting value without any indication of possible errors.

    ImqBoolean mqiStatistics ( MQLONG & statmqi );
    Provides a copy of the MQI statistics value. It returns TRUE if successful.

    MQLONG mqiStatistics ( );
    Returns the MQI statistics value without any indication of possible errors.

    ImqBoolean outboundPortMax ( MQLONG & max );
    Provides a copy of the maximum outbound port value. It returns TRUE if successful.

    MQLONG outboundPortMax ( );
    Returns the maximum outbound port value without any indication of possible errors.

    ImqBoolean outboundPortMin ( MQLONG & min );
    Provides a copy of the minimum outbound port value. It returns TRUE if successful.

    MQLONG outboundPortMin ( );
    Returns the minimum outbound port value without any indication of possible errors.

    ImqBinary password ( ) const;
    Returns the password used on client connections.

    ImqBoolean setPassword ( const ImqString & password );
    Sets the password used on client connections.

    ImqBoolean setPassword ( const char * = 0 password );
    Sets the password used on client connections.

    ImqBoolean setPassword ( const ImqBinary & password );
    Sets the password used on client connections.

    ImqBoolean performanceEvent( MQLONG & event );
    Provides a copy of the enablement state of the performance event. It returns TRUE if successful.

    MQLONG performanceEvent( );
    Returns the enablement state of the performance event without any indication of possible errors.

    ImqBoolean platform( MQLONG & platform );
    Provides a copy of the platform. It returns TRUE if successful.

    MQLONG platform( );
    Returns the platform without any indication of possible errors.

    ImqBoolean queueAccounting ( MQLONG & acctq );
    Provides a copy of the queue accounting value. It returns TRUE if successful.

    MQLONG queueAccounting ( );
    Returns the queue accounting value without any indication of possible errors.

    ImqBoolean queueMonitoring ( MQLONG & monq );
    Provides a copy of the queue monitoring value. It returns TRUE if successful.

    MQLONG queueMonitoring ( );
    Returns the queue monitoring value without any indication of possible errors.

    ImqBoolean queueStatistics ( MQLONG & statq );
    Provides a copy of the queue statistics value. It returns TRUE if successful.

    MQLONG queueStatistics ( );
    Returns the queue statistics value without any indication of possible errors.

    ImqBoolean receiveTimeout ( MQLONG & timeout );
    Provides a copy of the receive timeout value. It returns TRUE if successful.

    MQLONG receiveTimeout ( );
    Returns the receive timeout value without any indication of possible errors.

    ImqBoolean receiveTimeoutMin ( MQLONG & min );
    Provides a copy of the minimum receive timeout value. It returns TRUE if successful.

    MQLONG receiveTimeoutMin ( );
    Returns the minimum receive timeout value without any indication of possible errors.

    ImqBoolean receiveTimeoutType ( MQLONG & type );
    Provides a copy of the receive timeout type. It returns TRUE if successful.

    MQLONG receiveTimeoutType ( );
    Returns the receive timeout type without any indication of possible errors.

    ImqBoolean remoteEvent( MQLONG & event );
    Provides a copy of the enablement state of the remote event. It returns TRUE if successful.

    MQLONG remoteEvent( );
    Returns the enablement state of the remote event without any indication of possible errors.

    ImqBoolean repositoryName( ImqString & name );
    Provides a copy of the repository name. It returns TRUE if successful.

    ImqString repositoryName( );
    Returns the repository name without any indication of possible errors.

    ImqBoolean repositoryNamelistName( ImqString & name );
    Provides a copy of the repository namelist name. It returns TRUE if successful.

    ImqString repositoryNamelistName( );
    Returns a copy of the repository namelist name without any indication of possible errors.

    ImqBoolean sharedQueueQueueManagerName ( MQLONG & name );
    Provides a copy of the shared queue queue manager name value. It returns TRUE if successful.

    MQLONG sharedQueueQueueManagerName ( );
    Returns the shared queue queue manager name value without any indication of possible errors.

    ImqBoolean sslEvent ( MQLONG & event );
    Provides a copy of the SSL event value. It returns TRUE if successful.

    MQLONG sslEvent ( );
    Returns the SSL event value without any indication of possible errors.

    ImqBoolean sslFips ( MQLONG & sslfips );
    Provides a copy of the SSL FIPS value. It returns TRUE if successful.

    MQLONG sslFips ( );
    Returns the SSL FIPS value without any indication of possible errors.

    ImqBoolean sslKeyResetCount ( MQLONG & count );
    Provides a copy of the SSL key reset count value. It returns TRUE if successful.

    MQLONG sslKeyResetCount ( );
    Returns the SSL key reset count value without any indication of possible errors.

    ImqBoolean startStopEvent( MQLONG & event );
    Provides a copy of the enablement state of the start-stop event. It returns TRUE if successful.

    MQLONG startStopEvent( );
    Returns the enablement state of the start-stop event without any indication of possible errors.

    ImqBoolean statisticsInterval ( MQLONG & statint );
    Provides a copy of the statistics interval value. It returns TRUE if successful.

    MQLONG statisticsInterval ( );
    Returns the statistics interval value without any indication of possible errors.

    ImqBoolean syncPointAvailability( MQLONG & sync );
    Provides a copy of the syncpoint availability value. It returns TRUE if successful.

    MQLONG syncPointAvailability( );
    Returns a copy of the syncpoint availability value, without any indication of possible errors.

    ImqBoolean tcpName ( ImqString & name );
    Provides a copy of the TCP system name. It returns TRUE if successful.

    ImqString tcpName ( );
    Returns the TCP system name without any indication of possible errors.

    ImqBoolean tcpStackType ( MQLONG & type );
    Provides a copy of the TCP stack type. It returns TRUE if successful.

    MQLONG tcpStackType ( );
    Returns the TCP stack type without any indication of possible errors.

    ImqBoolean traceRouteRecording ( MQLONG & routerec );
    Provides a copy of the trace route recording value. It returns TRUE if successful.

    MQLONG traceRouteRecording ( );
    Returns the trace route recording value without any indication of possible errors.

    ImqBoolean triggerInterval( MQLONG & interval );
    Provides a copy of the trigger interval. It returns TRUE if successful.

    MQLONG triggerInterval( );
    Returns the trigger interval without any indication of possible errors.

    ImqBinary userId ( ) const;
    Returns the user ID used on client connections.

    ImqBoolean setUserId ( const ImqString & id );
    Sets the user ID used on client connections.

    ImqBoolean setUserId ( const char * = 0 id );
    Sets the user ID used on client connections.

    ImqBoolean setUserId ( const ImqBinary & id );
    Sets the user ID used on client connections.


Object methods (protected)

    void setFirstManagedObject ( const ImqObject * object = 0 );
    Sets the first managed object.


Object data (protected)

    MQHCONN ohconn
    The IBM MQ connection handle (meaningful only while the connection status is TRUE).


Reason codes

  • MQRC_ATTRIBUTE_LOCKED
  • MQRC_ENVIRONMENT_ERROR
  • MQRC_FUNCTION_NOT_SUPPORTED
  • MQRC_REFERENCE_ERROR
  • (reason codes for MQBACK)
  • (reason codes for MQBEGIN)
  • (reason codes for MQCMIT)
  • (reason codes for MQCONNX)
  • (reason codes for MQDISC)
  • (reason codes for MQCONN)

Parent topic: IBM MQ C++ classes