ImqReferenceHeaderクラス(C++)
このクラスは,MQRMH構造体の特定の機能をカプセル化します。
- 〈このページの構成〉
インクルードファイル
このクラスを使用するときは,imqrfh.hppファイルをインクルードしてください。
オブジェクト属性
● destination environment
宛先の環境です。初期値はヌル文字です。
● destination name
データ宛先の名前です。初期値はヌル文字です。
● instance id
長さがMQ_OBJECT_INSTANCE_ID_LENGTHの2進値(MQBYTE24)です。初期値はMQOII_NONEです。
MQRMH構造体の,ObjectInstanceIdフィールドに相当します。
● logical length
このヘッダに続くメッセージデータの論理上の長さ,つまり使用する予定の長さです。初期値は0です。
MQRMH構造体の,DataLogicalLengthフィールドに相当します。
● logical offset
後続のメッセージデータの論理オフセットです。最終宛先で,全体としてデータのコンテキストで解釈されます。初期値は0です。
MQRMH構造体の,DataLogicalOffsetフィールドに相当します。
● logical offset2
logical offsetへの高位拡張です。初期値は0です。
MQRMH構造体の,DataLogicalOffset2フィールドに相当します。
● reference type
参照タイプです。初期値はヌル文字です。
MQRMH構造体の,ObjectTypeフィールドに相当します。
● source environment
データ送信側の環境です。初期値はヌル文字です。
● source name
データ送信側の名前です。初期値はヌル文字です。
コンストラクタ
● ImqReferenceHeader();
デフォルトのコンストラクタです。
● ImqReferenceHeader( const ImqReferenceHeader & header );
コピーコンストラクタです。
メソッド
● virtual ImqBoolean copyOut( ImqMessage & msg );
多重定義されたImqItemメソッドです。MQRMH構造体をメッセージバッファの始めに挿入して,既存のメッセージデータを後ろにずらします。msg formatをMQFMT_REF_MSG_HEADERに設定します。
詳細については,「ImqHeaderクラス(C++)」を参照してください。
● virtual ImqBoolean pasteIn( ImqMessage & msg );
多重定義されたImqItemメソッドです。メッセージバッファからMQRMH構造体を読み取ります。
正常に実行するためには,ImqMessage formatがMQFMT_REF_MSG_HEADERでなければなりません。
詳細については,「ImqHeaderクラス(C++)」を参照してください。
● void operator = ( const ImqReferenceHeader & header );
インスタンスデータがヘッダファイルからコピーされ,既存のインスタンスデータと置き換えられます。
● ImqString destinationEnvironment() const;
destination environmentのコピーを返します。
● void setDestinationEnvironment( const char * environment = 0 );
destination environmentを設定します。
● ImqString destinationName() const ;
destination nameのコピーを返します。
● void setDestinationName( const char * name = 0 );
destination nameを設定します。
● ImqBinary instanceId() const ;
instance idのコピーを返します。
● ImqBoolean setInstanceId( const ImqBinary & id );
instance idを設定します。tokenのdata lengthは,0またはMQ_OBJECT_INSTANCE_ID_LENGTHのどちらかでなければなりません。正常に実行された場合はTRUEを返します。
● void setInstanceId( const MQBYTE24 id = 0 );
instance idを設定します。idが0の場合は,MQOII_NONEを指定するのと同じです。idが0でない場合は,MQ_OBJECT_INSTANCE_ID_LENGTHバイトの2進データをアドレス指定する必要があります。
MQOII_NONEなどの事前定義値を使用する場合は,確実に信号機能が一致するようにキャストを作成する必要があります。
キャストは,例えば(MQBYTE *)MQOII_NONEのように作成します。
● MQLONG logicalLength() const ;
logical lengthを返します。
● void setLogicalLength( const MQLONG length );
logical lengthを設定します。
● MQLONG logicalOffset() const ;
logical offsetを返します。
● void setLogicalOffset( const MQLONG offset );
logical offsetを設定します。
● MQLONG logicalOffset2() const;
logical offset2を返します。
● void setLogicalOffset2( const MQLONG offset );
logical offset2を設定します。
● ImqString referenceType() const ;
reference typeのコピーを返します。
● void setReferenceType( const char * name = 0 );
reference typeを設定します。
● ImqString sourceEnvironment() const ;
source environmentのコピーを返します。
● void setSourceEnvironment( const char * environment = 0 );
source environmentを設定します。
● ImqString sourceName() const ;
source nameのコピーを返します。
● void setSourceName( const char * name = 0 );
source nameを設定します。
オブジェクト属性(protected)
● MQRMH omqrmh
MQRMH構造体です。