WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 オペレーティング・システム: Linux, Windows

Message

Message オブジェクトは、アプリケーションが送信または受信するメッセージを表します。

継承の階層:
xms::PropertyContext
|
+----xms::Message

Message オブジェクトの JMS メッセージ・ヘッダー・フィールドのリストについては、XMS メッセージのヘッダー・フィールドを参照してください。 Message オブジェクトの JMS 定義プロパティーのリストについては、メッセージの JMS 定義プロパティーを参照してください。 Message オブジェクトの IBM 定義プロパティーのリストについては、メッセージの IBM 定義プロパティーを参照してください。

関連資料
XMS メッセージ

メソッド

メソッドの要約:
メソッド 説明
~Message メッセージを削除します。
acknowledge このメッセージと、セッションが以前に受信して、まだ応答していないすべてのメッセージに応答します。
clearBody メッセージの本体をクリアします。
clearProperties メッセージのプロパティーをクリアします。
getHandle C アプリケーションがメッセージにアクセスするときに使用するハンドルを取得します。
getJMSCorrelationID メッセージの相関 ID を取得します。
getJMSDeliveryMode メッセージの送達モードを取得します。
getJMSDestination メッセージ宛先を取得します。
getJMSExpiration メッセージの有効期限切れ時刻を取得します。
getJMSMessageID メッセージのメッセージ ID を取得します。
getJMSPriority メッセージの優先順位を取得します。
getJMSRedelivered メッセージが再配信されるかどうかの標識を取得します。
getJMSReplyTo メッセージに対する応答が送信される宛先を取得します。
getJMSTimestamp メッセージが送信された時刻を取得します。
getJMSType メッセージのタイプを取得します。
getProperties メッセージのプロパティーのリストを取得します。
isNull Message オブジェクトがヌル・オブジェクトであるかどうかを判別します。
propertyExists メッセージに、指定された名前のプロパティーがあるかどうかを検査します。
setJMSCorrelationID メッセージの相関 ID を設定します。
setJMSDeliveryMode メッセージの送達モードを設定します。
setJMSDestination メッセージ宛先を設定します。
setJMSExpiration メッセージの有効期限切れ時刻を設定します。
setJMSMessageID メッセージのメッセージ ID を設定します。
setJMSPriority メッセージの優先順位を設定します。
setJMSRedelivered メッセージが再配信されるかどうかを示します。
setJMSReplyTo メッセージに対する応答が送信される宛先を設定します。
setJMSTimestamp メッセージが送信される時刻を設定します。
setJMSType メッセージのタイプを設定します。

~Message – メッセージの削除

インターフェース:
virtual ~Message();

メッセージを削除します。

アプリケーションが、既に削除されているメッセージを削除しようとした場合、呼び出しは無視されます。

パラメーター:
なし
例外:
  • XMS_X_GENERAL_EXCEPTION

acknowledge – 応答

インターフェース:
xmsVOID acknowledge();

このメッセージと、セッションが以前に受信して、まだ応答していないすべてのメッセージに応答します。

セッションの応答モードが XMSC_CLIENT_ACKNOWLEDGE である場合、アプリケーションはこのメソッドを呼び出すことができます。セッションがその他の応答モードであるか、セッションが処理中である場合は、このメソッドの呼び出しは無視されます。

受信されたが、応答されていないメッセージは、再配信される可能性があります。

メッセージの応答について詳しくは、セッションでのメッセージの受信の確認を参照してください。

パラメーター:
なし
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_ILLEGAL_STATE_EXCEPTION

clearBody – 本体のクリア

インターフェース:
xmsVOID clearBody();

メッセージの本体をクリアします。ヘッダー・フィールドおよびメッセージ・プロパティーはクリアされません。

アプリケーションがメッセージ本体をクリアすると、本体は、新規に作成されたメッセージ内の空の本体と同じ状態になります。新規に作成されたメッセージ内の空の本体の状態は、メッセージ本体のタイプによって異なります。詳しくは、XMS メッセージの本文を参照してください。

アプリケーションは、本体の状態にかかわらず、いつでもメッセージ本体をクリアできます。 メッセージ本体が読み取り専用の場合、アプリケーションが本体に書き込むことができる唯一の方法は、まずアプリケーションが本体をクリアすることです。

パラメーター:
なし
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

clearProperties – プロパティーのクリア

インターフェース:
xmsVOID clearProperties();

メッセージのプロパティーをクリアします。ヘッダー・フィールドおよびメッセージ本体はクリアされません。

アプリケーションがメッセージのプロパティーをクリアした場合、プロパティーは読み書き可能になります。

アプリケーションは、プロパティーの状態にかかわらず、いつでもメッセージのプロパティーをクリアできます。メッセージのプロパティーが読み取り専用の場合、プロパティーを書き込み可能にすることができる唯一の方法は、アプリケーションがまずプロパティーをクリアすることです。

パラメーター:
なし
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

getHandle – ハンドルの取得

インターフェース:
xmsHMsg getHandle() const;

C アプリケーションがメッセージにアクセスするときに使用するハンドルを取得します。

パラメーター:
なし
戻り値:
メッセージのハンドル。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

getJMSCorrelationID – JMSCorrelationID の取得

インターフェース:
String getJMSCorrelationID() const;

メッセージの相関 ID を取得します。

パラメーター:
なし
戻り値:
相関 ID をカプセル化している String オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

getJMSDeliveryMode – JMSDeliveryMode の取得

インターフェース:
xmsINT getJMSDeliveryMode() const;

メッセージの送達モードを取得します。送達モードは、メッセージの送信時に MessageProducer.send() 呼び出しによって設定されます。

パラメーター:
なし
戻り値:
メッセージの送達モード。以下の値のいずれかです。
  • XMSC_DELIVERY_PERSISTENT
  • XMSC_DELIVERY_NON_PERSISTENT

新規に作成されて送信されていないメッセージの場合、送達モードは XMSC_DELIVERY_PERSISTENT です。ただし、送達モードが XMSC_DELIVERY_NON_PERSISTENT であるブローカーへのリアルタイム接続の場合を除きます。受信されたメッセージについては、受信側アプリケーションが setJMSDeliveryMode() を呼び出して送達モードを変更していない限り、このメソッドでは、メッセージ送信時に MessageProducer.send() 呼び出しによって設定された送達モードが戻されます。

例外:
  • XMS_X_GENERAL_EXCEPTION

getJMSDestination – JMSDestination の取得

インターフェース:
Destination getJMSDestination() const;

メッセージ宛先を取得します。宛先は、メッセージの送信時に MessageProducer.send() 呼び出しによって設定されます。

パラメーター:
なし
戻り値:
Destination オブジェクト。

未送信の新規作成メッセージの場合は、送信側アプリケーションが setJMSDestination() を呼び出して宛先を設定しない限り、メソッドはヌルの Destination オブジェクトを戻して、XMS_E_NOT_SET というエラー・コードを持つ例外をスローします。 受信されたメッセージについては、受信側アプリケーションが setJMSDestination() を呼び出して宛先を変更していない限り、このメソッドでは、メッセージ送信時に MessageProducer.send() 呼び出しによって設定された宛先の Destination オブジェクトが戻されます。

例外:
  • XMS_X_GENERAL_EXCEPTION

getJMSExpiration – JMSExpiration の取得

インターフェース:
xmsLONG getJMSExpiration() const;

メッセージの有効期限切れ時刻を取得します。

有効期限切れ時刻は、メッセージの送信時に MessageProducer.send() 呼び出しによって設定されます。その値は、送信側アプリケーションが指定した存続時間を、メッセージの送信時刻に加算して計算されます。有効期限切れ時刻は、1970 年 1 月 1 日 00:00:00 GMT からのミリ秒で表されます。

存続時間が 0 の場合、MessageProducer.send() 呼び出しでは、有効期限切れ時刻が 0 に設定されますが、これはメッセージの有効期限がないことを示します。

XMS は、有効期限が切れたメッセージを廃棄し、アプリケーションに配信しません。

パラメーター:
なし
戻り値:
メッセージの有効期限切れ時刻。

新規に作成されて送信されていないメッセージの場合、送信側アプリケーションが setJMSExpiration() を呼び出して異なる有効期限切れ時刻を設定していない限り、有効期限切れ時刻は 0 です。受信されたメッセージについては、受信側アプリケーションが setJMSExpiration() を呼び出して有効期限切れ時刻を変更していない限り、このメソッドでは、メッセージ送信時に MessageProducer.send() 呼び出しによって設定された有効期限切れ時刻が戻されます。

例外:
  • XMS_X_GENERAL_EXCEPTION

getJMSMessageID – JMSMessageID の取得

インターフェース:
String getJMSMessageID() const;

メッセージのメッセージ ID を取得します。メッセージ ID は、メッセージの送信時に MessageProducer.send() 呼び出しによって設定されます。

パラメーター:
なし
戻り値:
メッセージ ID をカプセル化している String オブジェクト。

受信されたメッセージについては、受信側アプリケーションが setJMSMessageID() を呼び出してメッセージ ID を変更していない限り、このメソッドでは、メッセージ送信時に MessageProducer.send() 呼び出しによって設定されたメッセージ ID が戻されます。

例外:
  • XMS_X_GENERAL_EXCEPTION
注:
  1. メッセージにメッセージ ID がない場合、メソッドは XMS_E_NOT_SET というエラー・コードを持つ例外をスローします。

getJMSPriority – JMSPriority の取得

インターフェース:
xmsINT getJMSPriority() const;

メッセージの優先順位を取得します。優先順位は、メッセージの送信時に MessageProducer.send() 呼び出しによって設定されます。

パラメーター:
なし
戻り値:
メッセージの優先順位。値は 0 (最低優先順位) から 9 (最高優先順位) までの整数です。

新規に作成されて送信されていないメッセージの場合、送信側アプリケーションが setJMSPriority() を呼び出して異なる優先順位を設定していない限り、優先順位は 4 です。受信されたメッセージについては、受信側アプリケーションが setJMSPriority() を呼び出して優先順位を変更していない限り、このメソッドでは、メッセージ送信時に MessageProducer.send() 呼び出しによって設定された優先順位が戻されます。

例外:
  • XMS_X_GENERAL_EXCEPTION

getJMSRedelivered – JMSRedelivered の取得

インターフェース:
xmsBOOL getJMSRedelivered() const;

メッセージが再配信されるかどうかの標識を取得します。標識は、メッセージの受信時に MessageConsumer.receive() 呼び出しによって設定されます。

パラメーター:
なし
戻り値:
  • メッセージが再配信される場合は、xmsTRUE です。
  • メッセージが再配信されない場合は、xmsFALSE です。

ブローカーへのリアルタイム接続の場合、常にメソッドは xmsFALSE を戻します。

例外:
  • XMS_X_GENERAL_EXCEPTION

getJMSReplyTo – JMSReplyTo の取得

インターフェース:
Destination getJMSReplyTo() const;

メッセージに対する応答が送信される宛先を取得します。

パラメーター:
なし
戻り値:
メッセージに対する応答が送信される宛先の Destination オブジェクト。Destination オブジェクトがヌルの場合は、応答を想定していないという意味です。
例外:
  • XMS_X_GENERAL_EXCEPTION

getJMSTimestamp – JMSTimestamp の取得

インターフェース:
xmsLONG getJMSTimestamp() const;

メッセージが送信された時刻を取得します。タイム・スタンプは、メッセージの送信時に MessageProducer.send() 呼び出しによって設定され、1970 年 1 月 1 日 00:00:00 GMT からのミリ秒で表されます。

パラメーター:
なし
戻り値:
メッセージが送信された時刻。

新規に作成されて送信されていないメッセージの場合、送信側アプリケーションが setJMSTimestamp() を呼び出して異なるタイム・スタンプを設定していない限り、タイム・スタンプは 0 です。受信したメッセージについては、受信側アプリケーションが setJMSTimestamp() を呼び出してタイム・スタンプを変更していない限り、このメソッドでは、メッセージ送信時に MessageProducer.send() 呼び出しによって設定されたタイム・スタンプが戻ります。

例外:
  • XMS_X_GENERAL_EXCEPTION
注:
  1. タイム・スタンプが未定義の場合、このメソッドは 0 を戻しますが例外はスローしません。

getJMSType – JMSType の取得

インターフェース:
String getJMSType() const;

メッセージのタイプを取得します。

パラメーター:
なし
戻り値:
メッセージのタイプをカプセル化している String オブジェクト。データ変換が必要な場合、これは変換後のタイプです。
例外:
  • XMS_X_GENERAL_EXCEPTION

getProperties – プロパティーの取得

インターフェース:
Iterator getProperties() const;

メッセージのプロパティーのリストを取得します。

このメソッドは、Property オブジェクトのリストをカプセル化するイテレーターを戻します。アプリケーションは、そのイテレーターを使用して、各プロパティーに順番にアクセスすることができます。

注: 同等の JMS メソッドでは、多少異なる働きをします。JMS メソッドでは、メッセージのプロパティーの名前のみを列挙した形で戻し、値は戻しません。
パラメーター:
なし
戻り値:
Iterator オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

isNull – ヌルであるかどうかを検査

インターフェース:
xmsBOOL isNull() const;

Message オブジェクトがヌル・オブジェクトであるかどうかを判別します。

パラメーター:
なし
戻り値:
  • Message オブジェクトがヌル・オブジェクトの場合は、xmsTRUE
  • Message オブジェクトがヌル・オブジェクトでない場合は、xmsFALSE
例外:
  • XMS_X_GENERAL_EXCEPTION

propertyExists – プロパティーの存在の検査

インターフェース:
xmsBOOL propertyExists(const String & propertyName) const;

メッセージに、指定された名前のプロパティーがあるかどうかを検査します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
戻り値:
  • 指定した名前のプロパティーがメッセージに存在する場合は、xmsTRUE です。
  • 指定した名前のプロパティーがメッセージに存在しない場合は、xmsFALSE です。
例外:
  • XMS_X_GENERAL_EXCEPTION

setJMSCorrelationID – JMSCorrelationID の設定

インターフェース:
xmsVOID setJMSCorrelationID(const String correlID);

メッセージの相関 ID を設定します。

パラメーター:
correlID (入力)
相関 ID をカプセル化している String オブジェクト。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setJMSDeliveryMode – JMSDeliveryMode の設定

インターフェース:
xmsVOID setJMSDeliveryMode(const xmsINT deliveryMode);

メッセージの送達モードを設定します。

メッセージの送信前にこのメソッドが設定した送達モードは、メッセージの送信時の MessageProducer.send() 呼び出しでは無視されて置き換えられます。ただし、このメソッドを使用して、受信されたメッセージの送達モードを変更することができます。

パラメーター:
deliveryMode (入力)
メッセージの送達モード。以下の値のいずれかでなければなりません。
  • XMSC_DELIVERY_PERSISTENT
  • XMSC_DELIVERY_NON_PERSISTENT
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setJMSDestination – JMSDestination の設定

インターフェース:
xmsVOID setJMSDestination(const Destination & destination);

メッセージ宛先を設定します。

メッセージの送信前にこのメソッドが設定した宛先は、メッセージの送信時の MessageProducer.send() 呼び出しでは無視されて置き換えられます。ただし、このメソッドを使用して、受信されたメッセージの宛先を変更することができます。

パラメーター:
destination (入力)
メッセージの宛先を表す Destination オブジェクト。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setJMSExpiration – JMSExpiration の設定

インターフェース:
xmsVOID setJMSExpiration(const xmsLONG expiration);

メッセージの有効期限切れ時刻を設定します。

メッセージの送信前にこのメソッドが設定した有効期限切れ時刻は、メッセージの送信時の MessageProducer.send() 呼び出しでは無視されて置き換えられます。ただし、このメソッドを使用して、受信されたメッセージの有効期限切れ時刻を変更することができます。

パラメーター:
expiration (入力)
1970 年 1 月 1 日 00:00:00 GMT からのミリ秒で表される有効期限切れ時刻。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setJMSMessageID – JMSMessageID の設定

インターフェース:
xmsVOID setJMSMessageID(const String & msgID);

メッセージのメッセージ ID を設定します。

メッセージの送信前にこのメソッドが設定したメッセージ ID は、メッセージの送信時の MessageProducer.send() 呼び出しでは無視されて置き換えられます。ただし、このメソッドを使用して、受信されたメッセージのメッセージ ID を変更することができます。

パラメーター:
msgID (入力)
メッセージ ID をカプセル化している String オブジェクト。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setJMSPriority – JMSPriority の設定

インターフェース:
xmsVOID setJMSPriority(const xmsINT priority);

メッセージの優先順位を設定します。

メッセージの送信前にこのメソッドが設定した優先順位は、メッセージの送信時の MessageProducer.send() 呼び出しでは無視されて置き換えられます。ただし、このメソッドを使用して、受信されたメッセージの優先順位を変更することができます。

パラメーター:
priority (入力)
メッセージの優先順位。値は 0 (最低優先順位) から 9 (最高優先順位) までの整数です。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setJMSRedelivered – JMSRedelivered の設定

インターフェース:
xmsVOID setJMSRedelivered(const xmsBOOL redelivered);

メッセージが再配信されるかどうかを示します。

メッセージの送信前にこのメソッドが設定した再配信の標識は、メッセージの送信時の MessageProducer.send() 呼び出しでは無視され、メッセージ受信時の MessageConsumer.receive() 呼び出しでは無視されて置き換えられます。ただし、このメソッドを使用して、受信されたメッセージの標識を変更することができます。

パラメーター:
redelivered (入力)
xmsTRUE は、メッセージが再配信されることを意味します。 値 xmsFALSE は、メッセージが再配信されないことを意味します。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setJMSReplyTo – JMSReplyTo の設定

インターフェース:
xmsVOID setJMSReplyTo(const Destination & destination);

メッセージに対する応答が送信される宛先を設定します。

パラメーター:
destination (入力)
メッセージに対する応答が送信される宛先を表す Destination オブジェクト。Destination オブジェクトがヌルの場合は、応答を想定していないという意味です。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setJMSTimestamp – JMSTimestamp の設定

インターフェース:
xmsVOID setJMSTimestamp(const xmsLONG timeStamp);

メッセージが送信される時刻を設定します。

メッセージの送信前にこのメソッドが設定したタイム・スタンプは、メッセージの送信時の MessageProducer.send() 呼び出しでは無視されて置き換えられます。ただし、このメソッドを使用して、受信されたメッセージのタイム・スタンプを変更することができます。

パラメーター:
timeStamp (入力)
1970 年 1 月 1 日 00:00:00 GMT からのミリ秒で表される、メッセージ送信の時刻。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setJMSType – JMSType の設定

インターフェース:
xmsVOID setJMSType(const String & type);

メッセージのタイプを設定します。

パラメーター:
type (入力)
メッセージのタイプをカプセル化している String オブジェクト。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

継承されたメソッド


Reference topic

ご利用条件 | フィードバック (英語のみ)

Timestamp icon最終更新: 8 Jun 2006
(C) Copyright IBM Corporation 2005, 2006. All Rights Reserved.
このインフォメーション・センターでは Eclipse テクノロジーが採用されています。(http://www.eclipse.org)