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

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

ImqDeadLetterHeaderクラス(C++)

このクラスは,MQDLH構造体の特定の機能をカプセル化します。このクラスのオブジェクトは,一般的に,処理不能なメッセージを検出するアプリケーションによって使用されます。送達不能ヘッダと処理不能なメッセージ内容とで構成される新規メッセージは送達不能キューに入れられ,その処理不能メッセージは破棄されます。

インクルードファイル

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

オブジェクト属性

● dead-letter reason code

メッセージが送達不能キューに届いた理由です。初期値はMQRC_NONEです。

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

● destination queue manager name

元の宛先キューマネジャの名前です。初期値はヌル文字です。

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

● destination queue name

元の宛先キューの名前です。初期値はヌル文字です。

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

● put application name

メッセージを送達不能キューに書き込んだアプリケーションの名前です。初期値はヌル文字です。

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

● put application type

メッセージを送達不能キューに書き込んだアプリケーションのタイプです。初期値は0です。

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

● put date

メッセージが送達不能キューに書き込まれた日付です。初期値は空白です。

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

● put time

メッセージが送達不能キューに書き込まれた時刻です。初期値は空白です。

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

コンストラクタ

● ImqDeadLetterHeader( );

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

● ImqDeadLetterHeader( const ImqDeadLetterHeader & header );

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

メソッド

● virtual ImqBoolean copyOut( ImqMessage & msg );

多重定義されたImqItemメソッドです。MQDLH構造体をメッセージバッファの初めに挿入し,既存のメッセージデータを後ろにずらします。msg formatをMQFMT_DEAD_LETTER_HEADERに設定します。

詳細については,「ImqHeaderクラス(C++)」の「メソッド」を参照してください。

● virtual ImqBoolean pasteIn( ImqMessage & msg );

多重定義されたImqItemメソッドです。メッセージバッファからMQDLH構造体を読み取ります。

正常に実行されるためには,ImqMessage formatがMQFMT_DEAD_LETTER_HEADERでなければなりません。

詳細については,「ImqHeaderクラス(C++)」の「メソッド」を参照してください。

● void operator = ( const ImqDeadLetterHeader & header );

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

● MQLONG deadLetterReasonCode( ) const ;

dead-letter reason codeを返します。

● void setDeadLetterReasonCode( const MQLONG reason );

dead-letter reason codeを設定します。

● ImqString destinationQueueManagerName( ) const ;

destination queue manager nameを返します。

● void setDestinationQueueManagerName( const char * name );

destination queue manager nameを設定します。

● ImqString destinationQueueName( ) const ;

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

● void setDestinationQueueName( const char * name );

destination queue nameを設定します。

● ImqString putApplicationName( ) const ;

put application nameのコピーを返します。

● void setPutApplicationName( const char * name = 0 );

put application nameを設定します。

● MQLONG putApplicationType( ) const ;

put application typeを返します。

● void setPutApplicationType( const MQLONG type = MQAT_NO_CONTEXT );

put application typeを設定します。

● ImqString putDate( ) const ;

put dateのコピーを返します。

● void setPutDate( const char * date = 0 );

put dateを設定します。

● ImqString putTime( ) const ;

put timeのコピーを返します。

● void setPutTime( const char * time = 0 );

put timeを設定します。

オブジェクト属性(protected)

● MQDLH omqdlh

MQDLH構造体です。

その他の関連クラス

ImqHeader

ImqItem

ImqMessage

ImqString