メッセージキューイングアクセス機能 TP1/Message Queue - Access 使用の手引

[目次][用語][索引][前へ][次へ]

ImqMessageTrackerクラス(C++)

この抽象クラスは,ImqMessageオブジェクトまたはImqQueueオブジェクトの属性のうち,もう一方のオブジェクトと関連づけることのできる属性をカプセル化します。

インクルードファイル

このクラスを使用するときは,imqmtr.hppファイルをインクルードしてください。

オブジェクト属性

● accounting token

長さMQ_ACCOUNTING_TOKEN_LENGTHの2進値(MQBYTE32)です。初期値はMQACT_NONEです。

MQMD構造体,MQPMR構造体の,AccountingTokenフィールドに相当します。

● correlation id

メッセージを相互に関連づける目的でユーザが割り当てた,長さがMQ_CORREL_ID_LENGTHの2進値(MQBYTE24)です。初期値はMQCI_NONEです。

MQMD構造体,MQPMR構造体の,CorrelIdフィールドに相当します。

● feedback

メッセージとともに送られるフィードバック情報です。初期値はMQFB_NONEです。

MQMD構造体,MQPMR構造体の,Feedbackフィールドに相当します。

● group id

キュー内で固有の長さMQ_GROUP_ID_LENGTHの2進値(MQBYTE24)です。初期値はMQGI_NONEです。

MQMD構造体,MQPMR構造体の,GroupIdフィールドに相当します。

● message id

キュー内で固有の長さMQ_MSG_ID_LENGTHの2進値(MQBYTE24)です。初期値はMQMI_NONEです。

MQMD構造体,MQPMR構造体の,MsgIdフィールドに相当します。

コンストラクタ

● ImqMessageTracker( );

デフォルトのコンストラクタです。

● ImqMessageTracker( const ImqMessageTracker & tracker );

コピーコンストラクタです。詳細については,「メソッド」のoperatorの説明を参照してください。

メソッド

● void operator = ( const ImqMessageTracker & tracker );

インスタンスデータがtrackerからコピーされ,既存のインスタンスデータと置き換えられます。

● ImqBinary accountingToken( ) const ;

accounting tokenのコピーを返します。

● ImqBoolean setAccountingToken( const ImqBinary & token );

accounting tokenを設定します。tokenのdata lengthは,0またはMQ_ACCOUNTING_TOKEN_ID_LENGTHのどちらかでなければなりません。正常に実行された場合はTRUEを返します。

● void setAccountingToken( const MQBYTE32 token = 0 );

accounting tokenを設定します。tokenが0の場合は,MQACT_NONEを指定するのと同じです。tokenが0でない場合は,MQ_ACCOUNTING_TOKEN_LENGTHバイトの2進データをアドレス指定する必要があります。

MQACT_NONEなどの事前定義値を使用する場合は,確実に信号機能が一致するようにキャストを作成する必要があります。

キャストは,例えば(MQBYTE *)MQACT_NONEのように作成します。

● ImqBinary correlationId( ) const ;

correlation idのコピーを返します。

● ImqBoolean setCorrelationId( const ImqBinary & token );

correlation idを設定します。tokenのdata lengthは,0またはMQ_CORREL_ID_LENGTHのどちらかでなければなりません。正常に実行された場合はTRUEを返します。

● void setCorrelationId( const MQBYTE24 id = 0 );

correlation idを設定します。idが0の場合は,MQCI_NONEを指定するのと同じです。idが0でない場合には,MQ_CORREL_ID_LENGTHバイトの2進データをアドレス指定する必要があります。MQCI_NONEなどの事前定義値を使用する場合は,確実に信号機能が一致するようにキャストを作成する必要があります。

キャストは,例えば(MQBYTE *)MQCI_NONE のように作成します。

● MQLONG feedback( ) const ;

feedbackを返します。

● void setFeedback( const MQLONG feedback );

feedbackを設定します。

● ImqBinary groupId() const ;

group idのコピーを返します。

● ImqBoolean setGroupId( const ImqBinary & token);

group idを設定します。tokenのdata lengthは,0またはMQ_GROUP_ID_LENGTHのどちらかでなければなりません。正常に実行された場合はTRUEを返します。

● void setGroupId( const MQBYTE24 id = 0);

group idを設定します。idが0の場合は,MQGI_NONEを指定するのと同じです。idが0でない場合は,MQ_GROUP_ID_LENGTHバイトの2進データをアドレス指定する必要があります。MQGI_NONEなどの事前定義値を使用する場合は,確実に信号機能が一致するようにキャストを作成する必要があります。

キャストは,例えば(MQBYTE *)MQGI_NONEのように作成します。

● ImqBinary messageId( ) const ;

message idのコピーを返します。

● ImqBoolean setMessageId( const ImqBinary & token );

message idを設定します。tokenのdata lengthは,0またはMQ_MSG_ID_LENGTHのどちらかでなければなりません。正常に実行された場合はTRUEを返します。

● void setMessageId( const MQBYTE24 id = 0 );

message idを設定します。idが0の場合は,MQMI_NONEを指定するのと同じです。idが0でない場合には,MQ_MSG_ID_LENGTHバイトの2進データをアドレス指定する必要があります。MQMI_NONEなどの事前定義値を使用する場合は,確実に信号機能が一致するようにキャストを作成する必要があります。

キャストは,例えば(MQBYTE*)MQMI_NONEのように作成します。

その他の関連クラス

ImqBinary

ImqError

ImqMessage

ImqQueue

理由コード

理由コードの詳細については,「付録A 理由コード」を参照してください。