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

Session

セッションとは、メッセージ送受信の単一スレッド・コンテキストです。

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

Session オブジェクトの XMS 定義プロパティーのリストについては、Session のプロパティーを参照してください。

メソッド

メソッドの要約:
メソッド 説明
close セッションを閉じます。
commit 現在のトランザクションで処理されたすべてのメッセージをコミットします。
createBrowser 指定されたキューのキュー・ブラウザーを作成します。
createBrowser メッセージ・セレクターを使用して、指定されたキューのキュー・ブラウザーを作成します。
createBytesMessage バイト・メッセージを作成します。
createConsumer 指定された宛先のメッセージ・コンシューマーを作成します。
createConsumer メッセージ・セレクターを使用して、指定された宛先のメッセージ・コンシューマーを作成します。
createConsumer メッセージ・セレクターを使用し、宛先がトピックの場合はメッセージ・コンシューマーが自身の接続により公開されたメッセージを受信するかどうかを指定して、指定された宛先のメッセージ・コンシューマーを作成します。
createDurableSubscriber 指定されたトピックの永続サブスクライバーを作成します。
createDurableSubscriber メッセージ・セレクターを使用し、永続サブスクライバーが自身の接続により公開されたメッセージを受信するかどうかを指定して、指定されたトピックの永続サブスクライバーを作成します。
createMapMessage マップ・メッセージを作成します。
createMessage 本体を持たないメッセージを作成します。
createObjectMessage オブジェクト・メッセージを作成します。
createProducer メッセージを指定された宛先へ送信するメッセージ・プロデューサーを作成します。
createQueue メッセージング・サーバー内のキューを表すための Destination オブジェクトを作成します。
createStreamMessage ストリーム・メッセージを作成します。
createTemporaryQueue 一時キューを作成します。
createTemporaryTopic 一時トピックを作成します。
createTextMessage 本体が空であるテキスト・メッセージを作成します。
createTextMessage 本体が指定されたテキストで初期化されているテキスト・メッセージを作成します。
createTopic トピックを表すための Destination オブジェクトを作成します。
getAcknowledgeMode セッションの肯定応答モードを取得します。
getHandle C アプリケーションがセッションにアクセスするときに使用するハンドルを取得します。
getTransacted セッションが処理済みであるかどうかを判別します。
isNull Session オブジェクトがヌル・オブジェクトであるかどうかを判別します。
recover セッションを回復します。
rollback 現在のトランザクションで処理されたすべてのメッセージをロールバックします。
unsubscribe 永続サブスクリプションを削除します。

close – セッションのクローズ

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

セッションを閉じます。セッションが処理済みの場合、進行中のトランザクションはロールバックされます。

セッションに従属するすべてのオブジェクトが削除されます。どのオブジェクトが削除されるかについては、オブジェクトの削除を参照してください。

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

パラメーター:
なし
戻り値:
Void
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

commit – コミット

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

現在のトランザクションで処理されたすべてのメッセージをコミットします。

セッションは、処理済みセッションでなければなりません。

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

createBrowser – キュー・ブラウザーの作成

インターフェース:
QueueBrowser createBrowser(const Destination & queue) const;

指定されたキューのキュー・ブラウザーを作成します。

パラメーター:
queue (入力)
キューを表す Destination オブジェクト。
戻り値:
QueueBrowser オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION

createBrowser – キュー・ブラウザーの作成 (メッセージ・セレクターを使用)

インターフェース:
QueueBrowser createBrowser(const Destination & queue
const String & messageSelector) const;

メッセージ・セレクターを使用して、指定されたキューのキュー・ブラウザーを作成します。

パラメーター:
queue (入力)
キューを表す Destination オブジェクト。
messageSelector (入力)
メッセージ・セレクター式をカプセル化している String オブジェクト。メッセージ・セレクター式に一致するプロパティーを持つメッセージのみが、キュー・ブラウザーに配信されます。

String オブジェクトがヌルであるとは、キュー・ブラウザー用のメッセージ・セレクターが存在しないという意味です。

戻り値:
QueueBrowser オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION
  • XMS_X_INVALID_SELECTOR_EXCEPTION

createBytesMessage – バイト・メッセージの作成

インターフェース:
BytesMessage createBytesMessage() const;

バイト・メッセージを作成します。

パラメーター:
なし
戻り値:
BytesMessage オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

createConsumer – コンシューマーの作成

インターフェース:
MessageConsumer createConsumer(const Destination & destination) const;

指定された宛先のメッセージ・コンシューマーを作成します。

パラメーター:
destination (入力)
Destination オブジェクト。
戻り値:
MessageConsumer オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION

createConsumer – コンシューマーの作成 (メッセージ・セレクターを使用)

インターフェース:
MessageConsumer createConsumer(const Destination & destination,
const String & messageSelector) const;

メッセージ・セレクターを使用して、指定された宛先のメッセージ・コンシューマーを作成します。

パラメーター:
destination (入力)
Destination オブジェクト。
messageSelector (入力)
メッセージ・セレクター式をカプセル化している String オブジェクト。メッセージ・セレクター式に一致するプロパティーを持つメッセージのみが、メッセージ・コンシューマーに配信されます。

String オブジェクトがヌルであるとは、メッセージ・コンシューマー用のメッセージ・セレクターが存在しないという意味です。

戻り値:
MessageConsumer オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION
  • XMS_X_INVALID_SELECTOR_EXCEPTION

createConsumer – コンシューマーの作成 (メッセージ・セレクターおよびローカル・メッセージ・フラグを使用)

インターフェース:
MessageConsumer createConsumer(const Destination & destination,
const String & messageSelector,
const xmsBOOL noLocal) const;

メッセージ・セレクターを使用し、宛先がトピックの場合はメッセージ・コンシューマーが自身の接続により公開されたメッセージを受信するかどうかを指定して、指定された宛先のメッセージ・コンシューマーを作成します。

パラメーター:
destination (入力)
Destination オブジェクト。
messageSelector (入力)
メッセージ・セレクター式をカプセル化している String オブジェクト。メッセージ・セレクター式に一致するプロパティーを持つメッセージのみが、メッセージ・コンシューマーに配信されます。

String オブジェクトがヌルであるとは、メッセージ・コンシューマー用のメッセージ・セレクターが存在しないという意味です。

noLocal (入力)
xmsTRUE は、メッセージ・コンシューマーが、自身の接続により公開されたメッセージを受信しないことを意味します。値 xmsFALSE は、メッセージ・コンシューマーが、自身の接続により公開されたメッセージを受信することを意味します。デフォルト値は xmsFALSE です。
戻り値:
MessageConsumer オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION
  • XMS_X_INVALID_SELECTOR_EXCEPTION

createDurableSubscriber – 永続サブスクライバーの作成

インターフェース:
MessageConsumer
createDurableSubscriber(const Destination & topic,
const String & subscriptionName) const;

指定されたトピックの永続サブスクライバーを作成します。

ブローカーへのリアルタイム接続の場合、このメソッドは無効です。

永続サブスクライバーについて詳しくは、永続サブスクライバーを参照してください。

パラメーター:
topic (入力)
トピックを表す Destination オブジェクト。トピックは、一時トピックであってはなりません。
subscriptionName (入力)
永続サブスクリプションを識別する名前をカプセル化している String オブジェクト。名前は、接続のクライアント ID 内で固有である必要があります。
戻り値:
永続サブスクライバーを表す MessageConsumer オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION

createDurableSubscriber – 永続サブスクライバーの作成 (メッセージ・セレクターおよびローカル・メッセージ・フラグを使用)

インターフェース:
MessageConsumer createDurableSubscriber(const Destination & topic,
const String & subscriptionName;
const String & messageSelector,
const xmsBOOL noLocal) const;

メッセージ・セレクターを使用し、永続サブスクライバーが自身の接続により公開されたメッセージを受信するかどうかを指定して、指定されたトピックの永続サブスクライバーを作成します。

ブローカーへのリアルタイム接続の場合、このメソッドは無効です。

永続サブスクライバーについて詳しくは、永続サブスクライバーを参照してください。

パラメーター:
topic (入力)
トピックを表す Destination オブジェクト。トピックは、一時トピックであってはなりません。
subscriptionName (入力)
永続サブスクリプションを識別する名前をカプセル化している String オブジェクト。名前は、接続のクライアント ID 内で固有である必要があります。
messageSelector (入力)
メッセージ・セレクター式をカプセル化している String オブジェクト。メッセージ・セレクター式に一致するプロパティーを持つメッセージのみが、永続サブスクライバーに配信されます。

String オブジェクトがヌルであるとは、永続サブスクライバー用のメッセージ・セレクターが存在しないという意味です。

noLocal (入力)
xmsTRUE は、永続サブスクライバーが、自身の接続により公開されたメッセージを受信しないことを意味します。値 xmsFALSE は、永続サブスクライバーが、自身の接続により公開されたメッセージを受信することを意味します。デフォルト値は xmsFALSE です。
戻り値:
永続サブスクライバーを表す MessageConsumer オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION
  • XMS_X_INVALID_SELECTOR_EXCEPTION

createMapMessage – マップ・メッセージの作成

インターフェース:
MapMessage createMapMessage() const;

マップ・メッセージを作成します。

パラメーター:
なし
戻り値:
MapMessage オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

createMessage – メッセージの作成

インターフェース:
Message createMessage() const;

本体を持たないメッセージを作成します。

パラメーター:
なし
戻り値:
Message オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

createObjectMessage – オブジェクト・メッセージの作成

インターフェース:
ObjectMessage createObjectMessage() const;

オブジェクト・メッセージを作成します。

パラメーター:
なし
戻り値:
ObjectMessage オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

createProducer – プロデューサーの作成

インターフェース:
MessageProducer createProducer(const Destination & destination) const;

メッセージを指定された宛先へ送信するメッセージ・プロデューサーを作成します。

パラメーター:
destination (入力)
Destination オブジェクト。

ヌルの Destination オブジェクトを指定すると、宛先のないメッセージ・プロデューサーが作成されます。 この場合アプリケーションは、メッセージを送信するためにメッセージ・プロデューサーを使用するたびに、宛先を指定する必要があります。

戻り値:
MessageProducer オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION

createQueue – キューの作成

インターフェース:
Destination createQueue(const String & queueName) const;

メッセージング・サーバー内のキューを表すための Destination オブジェクトを作成します。

このメソッドは、メッセージング・サーバー内にキューを作成しません。 アプリケーションがこのメソッドを呼び出すためには、その前にキューを作成する必要があります。

パラメーター:
queueName (入力)
キューの名前をカプセル化している String オブジェクト、またはキューを識別する Uniform Resource Identifier (URI) をカプセル化している String オブジェクト。
戻り値:
キューを表す Destination オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

createStreamMessage – ストリーム・メッセージの作成

インターフェース:
StreamMessage createStreamMessage() const;

ストリーム・メッセージを作成します。

パラメーター:
なし
戻り値:
StreamMessage オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

createTemporaryQueue – 一時キューの作成

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

一時キューを作成します。

一時キューのスコープは接続です。接続によって作成されたセッションのみが、一時キューを使用できます。

一時キューは、明示的に削除されるまで、あるいは接続が終了するまで存続します。

一時キューについて詳しくは、一時宛先を参照してください。

パラメーター:
なし
戻り値:
一時キューを表す Destination オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

createTemporaryTopic – 一時トピックの作成

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

一時トピックを作成します。

一時トピックのスコープは接続です。接続によって作成されたセッションのみが、一時トピックを使用できます。

一時トピックは、明示的な削除または接続終了のいずれかが発生するまで存在します。

一時トピックについて詳しくは、一時宛先を参照してください。

パラメーター:
なし
戻り値:
一時トピックを表す Destination オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

createTextMessage – テキスト・メッセージの作成

インターフェース:
TextMessage createTextMessage() const;

本体が空であるテキスト・メッセージを作成します。

パラメーター:
なし
戻り値:
TextMessage オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

createTextMessage – テキスト・メッセージの作成 (初期化済み)

インターフェース:
TextMessage createTextMessage(const String & text) const;

本体が指定されたテキストで初期化されているテキスト・メッセージを作成します。

パラメーター:
text (入力)
テキスト・メッセージの本体を初期化するためのテキストをカプセル化している String オブジェクト。
なし
戻り値:
TextMessage オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

createTopic – トピックの作成

インターフェース:
Destination createTopic(const String & topicName) const;

トピックを表すための Destination オブジェクトを作成します。

パラメーター:
topicName (入力)
トピックの名前をカプセル化している String オブジェクト、またはトピックを識別する Uniform Resource Identifier (URI) をカプセル化している String オブジェクト。
戻り値:
トピックを表す Destination オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

getAcknowledgeMode – 肯定応答モードの取得

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

セッションの肯定応答モードを取得します。肯定応答モードは、セッション作成時に指定されます。

処理済みのセッションには、肯定応答モードはありません。

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

パラメーター:
なし
戻り値:
肯定応答モード。セッションが処理されていない場合、肯定応答モードは以下の値のいずれかです。
  • XMSC_AUTO_ACKNOWLEDGE
  • XMSC_CLIENT_ACKNOWLEDGE
  • XMSC_DUPS_OK_ACKNOWLEDGE
セッションが処理された場合、メソッドは代わりに XMSC_SESSION_TRANSACTED を戻します。
例外:
  • XMS_X_GENERAL_EXCEPTION

getHandle – ハンドルの取得

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

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

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

getTransacted – 処理済みであるかどうかの判別

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

セッションが処理済みであるかどうかを判別します。

パラメーター:
なし
戻り値:
  • セッションが処理されている場合は、xmsTRUE です。
  • セッションが処理されていない場合は、xmsFALSE です。

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

例外:
  • XMS_X_GENERAL_EXCEPTION

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

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

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

パラメーター:
なし
戻り値:
  • Session オブジェクトがヌル・オブジェクトの場合は、xmsTRUE
  • Session オブジェクトがヌル・オブジェクトでない場合は、xmsFALSE
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

recover – 回復

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

セッションを回復します。メッセージ配信が一旦停止され、その後応答されていない最も古いメッセージを使用して再開されます。

セッションは、処理済みセッションであってはなりません。

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

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

rollback – ロールバック

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

現在のトランザクションで処理されたすべてのメッセージをロールバックします。

セッションは、処理済みセッションでなければなりません。

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

unsubscribe – アンサブスクライブ

インターフェース:
xmsVOID unsubscribe(const String & subscriptionName) const;

永続サブスクリプションを削除します。メッセージング・サーバーは 維持している永続サブスクリプションのレコードを削除し、これ以降永続サブスクライバーにメッセージを送信 しなくなります。

アプリケーションは、以下のいずれの状況でも、永続サブスクリプションを削除することはできません。
  • 永続サブスクリプションのアクティブなメッセージ・コンシューマーがあるとき
  • コンシュームされたメッセージが保留中のトランザクションの一部であるとき
  • コンシュームされたメッセージが応答されていないとき

ブローカーへのリアルタイム接続の場合、このメソッドは無効です。

パラメーター:
subscriptionName (入力)
永続サブスクリプションを識別する名前をカプセル化している String オブジェクト。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION
  • XMS_X_ILLEGAL_STATE_EXCEPTION

継承されたメソッド


Reference topic

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

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