ImqChannel C++ 类

对象属性

批处理脉动信号

检查远程通道是否处于活动状态之间的毫秒数。 初始值为 0。

渠道名称

通道的名称。 初始值为空。

连接名称

连接的名称。 例如，主机的 IP 地址。 初始值为空。

头压缩

通道所支持的头数据压缩技术列表。 初始值全部设置为 MQCOMPRESS_NOT_AVAILABLE。

心跳间隔

两次检查连接是否仍在工作之间的秒数。 初始值为 300。

保持活动时间间隔

传递到通信堆栈的秒数，用于指定通道的保持活动计时。 初始值为 MQKAI_AUTO。

本地地址

通道的本地通信地址。

最大消息长度

通道在单个通信中支持的最大消息长度。 初始值为 4 194 304。

消息压缩

通道支持的消息数据压缩技术的列表。 初始值全部设置为 MQCOMPRESS_NOT_AVAILABLE。

方式名

方式的名称。 初始值为空。

密码

为连接认证提供的密码。 初始值为空。

接收出口计数

接收出口的数量。 初始值为零。 此属性是只读的。

接收出口名称

接收出口的名称。

接收用户数据

与接收出口关联的数据。

安全出口名

要在连接的服务器端调用的安全出口的名称。 初始值为空。

安全性用户数据

要传递到安全出口的数据。 初始值为空。

发送出口计数

发送出口数。 初始值为零。 此属性是只读的。

发送出口名称

发送出口的名称。

发送用户数据

与发送出口关联的数据。

SSL CipherSpec

CipherSpec ，用于 TLS。

SSL 客户机认证类型

用于 TLS 的客户机认证类型。

SSL 对等名称

用于 TLS 的对等名称。

事务程序名

事务程序的名称。 初始值为空。

传输类型

连接的传输类型。 初始值为 MQXPT_LU62。

用户标识

为授权提供的用户标识。 初始值为空。

构造函数

ImqChannel( ) ;

缺省构造函数。

ImqChannel( ( const ImqChannel & channel );

复制构造函数。

对象方法 (公用)

void operator = ( const ImqChannel & 通道 );

从 channel复制实例数据，替换任何现有实例数据。

MQLONG batchHeartBeat( ) const;

返回 batch heart-beat。

ImqBoolean setBatchHeartBeat( ( const MQLONG heartbeat = 0L );

设置 批处理脉动信号。 如果成功，此方法将返回 TRUE。

ImqString channelName( const ;

返回 通道名称。

ImqBoolean setChannelName( ( const char * name = 0 );

设置 通道名称。 如果成功，此方法将返回 TRUE。

connectionName( ) const ;

返回 连接名称。

ImqBoolean setConnectionName( ( const char * name = 0 );

设置 连接名称。 如果成功，此方法将返回 TRUE。

size_t headerCompressionCount( ) const;

返回受支持的头数据压缩技术计数。

ImqBoolean headerCompression( ( const size_t count, MQLONG compress [ ] ) const ;

返回 compress中受支持的头数据压缩技术的副本。 如果成功，此方法将返回 TRUE。

ImqBoolean setHeaderCompression( ( const size_t count, const MQLONG compress [ ] );

将受支持的头数据压缩技术设置为 compress。

将受支持的头数据压缩技术计数设置为 count。

如果成功，此方法将返回 TRUE。

MQLONG heartBeatInterval( ) const;

返回 脉动信号间隔。

ImqBoolean setHeartBeatInterval( ( const MQLONG interval = 300L );

设置 脉动信号间隔。 如果成功，此方法将返回 TRUE。

MQLONG keepAliveInterval( ) const;

返回 保持活动时间间隔。

ImqBoolean setKeepAliveInterval( ( const MQLONG interval = MQKAI_AUTO );

设置 保持活动时间间隔。 如果成功，此方法将返回 TRUE。

ImqString localAddress( const ;

返回 本地地址。

ImqBoolean setLocalAddress ( const char * address = 0 );

设置 本地地址。 如果成功，此方法将返回 TRUE。

MQLONG maximumMessageLength( ) const;

返回 最大消息长度。

ImqBoolean setMaximumMessageLength( ( const MQLONG length = 4194304L );

设置 最大消息长度。 如果成功，此方法将返回 TRUE。

size_t messageCompressionCount( ) const;

返回受支持的消息数据压缩技术计数。

ImqBoolean messageCompression( ( const size_t count, MQLONG compress [ ]) const ;

返回 compress中受支持的消息数据压缩技术的副本。 如果成功，此方法将返回 TRUE。

ImqBoolean setMessageCompression( ( const size_t count, const MQLONG compress [ ] );

设置要压缩的受支持消息数据压缩技术。

将受支持的消息数据压缩技术计数设置为计数。

如果成功，此方法将返回 TRUE。

ImqString modeName( const;

返回 mode name。

ImqBoolean setModeName( ( const char * name = 0 );

设置 方式名。 如果成功，此方法将返回 TRUE。

ImqString password () 康斯特;

返回 password。

ImqBoolean setPassword( ( const char * password = 0 );

设置 password。 如果成功，此方法将返回 TRUE。

size_t receiveExitCount( ) const;

返回 接收出口计数。

ImqString receiveExitName( );

返回第一个 接收出口名称(如果有)。 如果 接收出口计数 为零，那么将返回空字符串。

ImqBoolean receiveExitNames( ( const size_t count, ImqString * names [ ] );

返回 names中的 receive exit names 的副本。 将超过 receive exit count 的任何 names 设置为空字符串。 如果成功，此方法将返回 TRUE。

ImqBoolean setReceiveExitName( ( const char * name = 0 );

将 接收出口名称 设置为单个 名称。 name 可以为空或空。 将 接收出口计数 设置为 1 或零。 清除 接收用户数据。 如果成功，此方法将返回 TRUE。

ImqBoolean setReceiveExitNames( ( const size_t count, const char * names [ ] );

将 接收出口名称 设置为 names。 个别 names 值不得为空或为空。 将 接收出口计数 设置为 count。 清除 接收用户数据。 如果成功，此方法将返回 TRUE。

ImqBoolean setReceiveExitNames( ( const size_t count, const ImqString * names [ ] );

将 接收出口名称 设置为 names。 个别 names 值不得为空或为空。 将 接收出口计数 设置为 count。 清除 接收用户数据。 如果成功，此方法将返回 TRUE。

ImqString receiveUserData( );

返回第一个 接收用户数据 项 (如果有)。 如果 接收出口计数 为零，那么返回空字符串。

ImqBoolean receiveUserData( ( const size_t count, ImqString * data [ ] );

返回 data中 receive user data 项的副本。 将超出 接收出口计数 的任何 数据 设置为空字符串。 如果成功，此方法将返回 TRUE。

ImqBoolean setReceiveUserData( ( const char * data = 0 );

将 接收用户数据 设置为单个项 数据。 如果 data 不为空，那么 receive exit count 必须至少为 1。 如果成功，此方法将返回 TRUE。

ImqBoolean setReceiveUserData( ( const size_t count, const char * data [ ] );

将 接收用户数据 设置为 data。 count 必须不大于 receive exit count。 如果成功，此方法将返回 TRUE。

ImqBoolean setReceiveUserData( ( const size_t count, ImqString ImqString * data [ ] );

将 接收用户数据 设置为 data。 count 必须不大于 receive exit count。 如果成功，此方法将返回 TRUE。

ImqString securityExitName( const;

返回 安全出口名称。

ImqBoolean setSecurityExitName( ( const char * name = 0 );

设置 安全出口名称。 如果成功，此方法将返回 TRUE。

ImqString securityUserData( const;

返回 安全用户数据。

ImqBoolean setSecurityUserData( ( const char * data = 0 );

设置 安全用户数据。 如果成功，此方法将返回 TRUE。

size_t sendExitCount( ) const;

返回 发送出口计数。

ImqString sendExitName( );

返回第一个 发送出口名称(如果有)。 如果 发送出口计数 为零，那么返回空字符串。

ImqBoolean sendExitNames( ( const size_t count, ImqString * names [ ] );

返回 names中 send exit names 的副本。 将超出 发送出口计数 的任何 名称 设置为空字符串。 如果成功，此方法将返回 TRUE。

ImqBoolean setSendExitName( ( const char * name = 0 );

将 发送出口名称 设置为单个 名称。 name 可以为空或空。 将 发送出口计数 设置为 1 或零。 清除 发送用户数据。 如果成功，此方法将返回 TRUE

ImqBoolean setSendExitNames( ( const size_t count, const char * names [ ] );

将 send exit names 设置为 names。 个别 names 值不得为空或为空。 将 发送出口计数 设置为 count。 清除 发送用户数据。 如果成功，此方法将返回 TRUE。

ImqBoolean setSendExitNames( ( const size_t count, const ImqString * names [ ] );

将 send exit names 设置为 names。 个别 names 值不得为空或为空。 将 发送出口计数 设置为 count。 清除 发送用户数据。 如果成功，此方法将返回 TRUE。

ImqString sendUserData( );

返回第一个 发送用户数据 项 (如果有)。 如果 发送出口计数 为零，那么返回空字符串。

ImqBoolean sendUserData( ( const size_t count, ImqString * data [ ] );

返回 data中 send user data 项的副本。 将超出 发送出口计数 的任何 数据 设置为空字符串。 如果成功，此方法将返回 TRUE。

ImqBoolean setSendUserData( ( const char * data = 0 );

将 发送用户数据 设置为单个项 数据。 如果 data 不为空，那么 send exit count 必须至少为 1。 如果成功，此方法将返回 TRUE。

ImqBoolean setSendUserData( ( const size_t count, const char * data [ ] );

将 发送用户数据 设置为 数据。 count 必须不大于 send exit count。 如果成功，此方法将返回 TRUE。

ImqBoolean setSendUserData( ( const size_t count, ImqString ImqString * data [ ] );

将 发送用户数据 设置为 数据。 count 必须不大于 send exit count。 如果成功，此方法将返回 TRUE。

ImqString sslCipherSpecification( const;

返回 TLS 密码规范。

ImqBoolean setSslCipherSpecification( ( const char * name = 0 );

设置 TLS 密码规范。 如果成功，此方法将返回 TRUE。

MQLONG sslClientAuthentication( ) const;

返回 TLS 客户机认证类型。

ImqBoolean setSslClientAuthentication( ( const MQLONG auth = MQSCA_REQUIRED);

设置 TLS 客户机认证类型。 如果成功，此方法将返回 TRUE。

ImqString sslPeerName( const;

返回 TLS 对等名称。

ImqBoolean setSslPeerName( ( const char * name = 0 );

设置 TLS 对等名称。 如果成功，此方法将返回 TRUE。

ImqString transactionProgramName( const;

返回 事务程序名。

ImqBoolean setTransactionProgramName( ( const char * name = 0 );

设置 事务程序名。 如果成功，此方法将返回 TRUE。

MQLONG transportType( ) const;

返回 传输类型。

ImqBoolean setTransportType( ( const MQLONG type = MQXPT_LU62 );

设置 传输类型。 如果成功，此方法将返回 TRUE。

ImqString userId( const;

返回 用户标识。

ImqBoolean setUserId( ( const char * id = 0 );

设置 用户标识。 如果成功，此方法将返回 TRUE。

原因码

• 消息队列资源中心数据长度错误
• MQRC_项目计数错误
• MQRC_NULL_POINTER
• 消息队列资源中心源缓冲区错误