Hitachi

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


ImqGetMessageOptionsクラス(C++)

このクラスは,MQGMO構造体をカプセル化します。

〈このページの構成〉

インクルードファイル

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

オブジェクト属性

● group status

メッセージのグループに関連するメッセージの状況です。初期値はMQGS_NOT_IN_GROUPです。

MQGMO構造体の,GroupStatusフィールドに相当します。

● match options

着信メッセージを選択するためのオプションです。初期値は,MQMO_MATCH_MSG_IDまたはMQMO_MATCH_CORREL_IDです。

MQGMO構造体の,MatchOptionsフィールドに相当します。

● options

メッセージに適用できるオプションです。初期値はMQGMO_NO_WAITです。

MQGMO構造体の,Optionsフィールドに相当します。

● resolved queue name

解決されたキューの名前です。属性は読み取り専用です。名前は長さが48文字以下でなければならないので,その長さになるまでヌル文字が埋められます。初期値は空白です。

MQGMO構造体の,ResolvedQNameフィールドに相当します。

● segmentation

メッセージを分割する機能です。初期値はMSEG_INHIBITEDです。

MQGMO構造体の,Segmentationフィールドに相当します。

● segment status

メッセージの分割状況です。初期値はMQSS_NOT_A_SEGMENTです。

MQGMO構造体の,SegmentStatusフィールドに相当します。

● sync-point participation

同期点制御を受けてメッセージが検索される場合はTRUEです。

● wait interval

適切なメッセージがまだ使用可能でない場合に,ImqQueueクラスのgetメソッドが適切なメッセージの着信を待つ時間の長さです。初期値は0で,この場合は無期限に待機します。optionsにMQGMO_WAITが組み込まれていない場合は,この属性は無視されます。

MQGMO構造体の,WaitIntervalフィールドに相当します。

コンストラクタ

● ImqGetMessageOptions( );

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

● ImqGetMessageOptions( const ImqGetMessageOptions & gmo );

コピーコンストラクタです。

メソッド

● void operator = ( const ImqGetMessageOptions & gmo );

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

● MQCHAR groupStatus() const ;

group statusを返します。

● void setGroupStatus( const MQCHAR status);

group statusを設定します。

● MQLONG matchOptions() const ;

match optionsを返します。

● void setMatchOptions( const MQLONG options);

match optionsを設定します。

● MQLONG options( ) const ;

optionsを返します。

● void setOptions( const MQLONG options );

sync-point participation値を組み込んで,optionsを設定します。

● ImqString resolvedQueueName( ) const ;

resolved queue nameのコピーを返します。

● MQCHAR segmentation( ) const ;

segmentationを返します。

● void setSegmentation( const MQCHAR value );

segmentationを設定します。

● MQCHAR segmentStatus( ) const ;

segment statusを返します。

● void setSegmentStatus( const MQCHAR status );

segment statusを設定します。

● ImqBoolean syncPointParticipation( ) const ;

sync-point participation値を返します。optionsにMQGMO_SYNCPOINTが組み込まれている場合はTRUEを返します。

● void setSyncPointParticipation( const ImqBoolean sync );

sync-point participation値を設定します。optionsのMQGMO_SYNCPOINTフラグだけを変更します。

● MQLONG waitInterval( ) const ;

wait intervalを返します。

● void setWaitInterval( const MQLONG interval );

wait intervalを設定します。

オブジェクト属性(protected)

● PMQGMO opgmo

MQGMO構造体のアドレスです。

● MQLONG olVersion

opgmoでアドレス指定されたMQGMO構造体のバージョン番号です。

その他の関連クラス

ImqString