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

Session

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

セッションの XMS 定義プロパティーのリストについては、Session のプロパティーを参照してください。

関数

関数の要約:
関数 説明
xmsSessClose セッションを閉じます。
xmsSessCommit 現在のトランザクションで処理されたすべてのメッセージをコミットします。
xmsSessCreateBrowser 指定されたキューのキュー・ブラウザーを作成します。
xmsSessCreateBrowserSelector メッセージ・セレクターを使用して、指定されたキューのキュー・ブラウザーを作成します。
xmsSessCreateBytesMessage バイト・メッセージを作成します。
xmsSessCreateConsumer 指定された宛先のメッセージ・コンシューマーを作成します。
xmsSessCreateConsumerSelector メッセージ・セレクターを使用して、指定された宛先のメッセージ・コンシューマーを作成します。
xmsSessCreateConsumerSelectorLocal メッセージ・セレクターを使用し、宛先がトピックの場合はメッセージ・コンシューマーが自身の接続により公開されたメッセージを受信するかどうかを指定して、指定された宛先のメッセージ・コンシューマーを作成します。
xmsSessCreateDurableSubscriber 指定されたトピックの永続サブスクライバーを作成します。
xmsSessCreateDurableSubscriberSelector メッセージ・セレクターを使用し、永続サブスクライバーが自身の接続により公開されたメッセージを受信するかどうかを指定して、指定されたトピックの永続サブスクライバーを作成します。
xmsSessCreateMapMessage マップ・メッセージを作成します。
xmsSessCreateMessage 本体を持たないメッセージを作成します。
xmsSessCreateObjectMessage オブジェクト・メッセージを作成します。
xmsSessCreateProducer メッセージを指定された宛先へ送信するメッセージ・プロデューサーを作成します。
xmsSessCreateStreamMessage ストリーム・メッセージを作成します。
xmsSessCreateTextMessage 本体が空であるテキスト・メッセージを作成します。
xmsSessCreateTextMessageInit 本体が指定されたテキストで初期化されているテキスト・メッセージを作成します。
xmsSessGetAcknowledgeMode セッションの肯定応答モードを取得します。
xmsSessGetTransacted セッションが処理済みであるかどうかを判別します。
xmsSessRecover セッションを回復します。
xmsSessRollback 現在のトランザクションで処理されたすべてのメッセージをロールバックします。
xmsSessUnsubscribe 永続サブスクリプションを削除します。

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

インターフェース:
xmsRC xmsSessClose(xmsHSess *session,
xmsHErrorBlock errorBlock);

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

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

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

パラメーター:
session (入出力)
入力では、セッションのハンドル。出力で、関数は NULL ハンドルを戻します。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsSessCommit – コミット

インターフェース:
xmsRC xmsSessCommit(xmsHSess session,
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。セッションは、処理済みセッションでなければなりません。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_ILLEGAL_STATE_EXCEPTION
  • XMS_X_TRANSACTION_ROLLED_BACK_EXCEPTION

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

インターフェース:
xmsRC xmsSessCreateBrowser(xmsHSess session,
xmsHDest queue,
xmsHQueueBrowser *browser
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。
queue (入力)
キューを表す Destination オブジェクトのハンドル。
browser (出力)
キュー・ブラウザーのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION

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

インターフェース:
xmsRC xmsSessCreateBrowserSelector(xmsHSess session,
xmsHDest queue,
xmsCHAR *messageSelector,
xmsINT length,
xmsHQueueBrowser *browser
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。
queue (入力)
キューを表す Destination オブジェクトのハンドル。
messageSelector (入力)
文字配列としてのメッセージ・セレクター式。メッセージ・セレクター式に一致するプロパティーを持つメッセージのみが、キュー・ブラウザーに配信されます。

ヌルの値または空ストリングである場合は、キュー・ブラウザーのメッセージ・セレクターがないことを意味します。

length (入力)
メッセージ・セレクター式の長さ (バイト単位)。メッセージ・セレクター式がヌルで終了し、ヌル文字が埋め込まれていない場合、代わりに XMSC_CALCULATE_STRING_SIZE を指定して、XMS が長さを計算できるようにすることも可能です。
browser (出力)
キュー・ブラウザーのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION
  • XMS_X_INVALID_SELECTOR_EXCEPTION

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

インターフェース:
xmsRC xmsSessCreateBytesMessage(xmsHSess session,
xmsHMsg *message,
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。
message (出力)
バイト・メッセージのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsSessCreateConsumer(xmsHSess session,
xmsHDest destination,
xmsHMsgConsumer *consumer,
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。
destination (入力)
宛先のハンドル。
consumer (出力)
メッセージ・コンシューマーのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION

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

インターフェース:
xmsRC xmsSessCreateConsumerSelector(xmsHSess session,
xmsHDest destination,
xmsCHAR *messageSelector,
xmsINT length,
xmsHMsgConsumer *consumer,
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。
destination (入力)
宛先のハンドル。
messageSelector (入力)
文字配列としてのメッセージ・セレクター式。メッセージ・セレクター式に一致するプロパティーを持つメッセージのみが、メッセージ・コンシューマーに配信されます。

ヌルの値または空ストリングである場合は、メッセージ・コンシューマーのメッセージ・セレクターがないことを意味します。

length (入力)
メッセージ・セレクター式の長さ (バイト単位)。メッセージ・セレクター式がヌルで終了し、ヌル文字が埋め込まれていない場合、代わりに XMSC_CALCULATE_STRING_SIZE を指定して、XMS が長さを計算できるようにすることも可能です。
consumer (出力)
メッセージ・コンシューマーのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION
  • XMS_X_INVALID_SELECTOR_EXCEPTION

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

インターフェース:
xmsRC xmsSessCreateConsumerSelectorLocal(xmsHSess session,
xmsHDest destination,
xmsCHAR *messageSelector,
xmsINT length,
xmsBOOL noLocal,
xmsHMsgConsumer *consumer,
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。
destination (入力)
宛先のハンドル。
messageSelector (入力)
文字配列としてのメッセージ・セレクター式。メッセージ・セレクター式に一致するプロパティーを持つメッセージのみが、メッセージ・コンシューマーに配信されます。

ヌルの値または空ストリングである場合は、メッセージ・コンシューマーのメッセージ・セレクターがないことを意味します。

length (入力)
メッセージ・セレクター式の長さ (バイト単位)。メッセージ・セレクター式がヌルで終了し、ヌル文字が埋め込まれていない場合、代わりに XMSC_CALCULATE_STRING_SIZE を指定して、XMS が長さを計算できるようにすることも可能です。
noLocal (入力)
xmsTRUE は、メッセージ・コンシューマーが、自身の接続により公開されたメッセージを受信しないことを意味します。値 xmsFALSE は、メッセージ・コンシューマーが、自身の接続により公開されたメッセージを受信することを意味します。デフォルト値は xmsFALSE です。
consumer (出力)
メッセージ・コンシューマーのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION
  • XMS_X_INVALID_SELECTOR_EXCEPTION

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

インターフェース:
xmsRC xmsSessCreateDurableSubscriber(xmsHSess session,
xmsHDest topic,
xmsCHAR *subscriptionName
xmsHMsgConsumer *subscriber,
xmsHErrorBlock errorBlock);

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

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

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

パラメーター:
session (入力)
セッションのハンドル。
topic (入力)
トピックを表す Destination オブジェクトのハンドル。トピックは、一時トピックであってはなりません。
subscriptionName (入力)
永続サブスクリプションを識別する名前。名前は、接続のクライアント ID 内で固有でなければならず、ヌル終了ストリング形式です。
subscriber (出力)
永続サブスクライバーを表す MessageConsumer オブジェクトのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION

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

インターフェース:
xmsRC xmsSessCreateDurableSubscriberSelector(xmsHSess session,
xmsHDest topic,
xmsCHAR *subscriptionName
xmsCHAR *messageSelector,
xmsINT length,
xmsBOOL noLocal,
xmsHMsgConsumer *subscriber,
xmsHErrorBlock errorBlock);

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

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

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

パラメーター:
session (入力)
セッションのハンドル。
topic (入力)
トピックを表す Destination オブジェクトのハンドル。トピックは、一時トピックであってはなりません。
subscriptionName (入力)
永続サブスクリプションを識別する名前。名前は、接続のクライアント ID 内で固有でなければならず、ヌル終了ストリング形式です。
messageSelector (入力)
文字配列としてのメッセージ・セレクター式。メッセージ・セレクター式に一致するプロパティーを持つメッセージのみが、永続サブスクライバーに配信されます。

ヌルの値または空ストリングである場合は、永続サブスクライバーのメッセージ・セレクターがないことを意味します。

length (入力)
メッセージ・セレクター式の長さ (バイト単位)。メッセージ・セレクター式がヌルで終了し、ヌル文字が埋め込まれていない場合、代わりに XMSC_CALCULATE_STRING_SIZE を指定して、XMS が長さを計算できるようにすることも可能です。
noLocal (入力)
xmsTRUE は、永続サブスクライバーが、自身の接続により公開されたメッセージを受信しないことを意味します。値 xmsFALSE は、永続サブスクライバーが、自身の接続により公開されたメッセージを受信することを意味します。デフォルト値は xmsFALSE です。
subscriber (出力)
永続サブスクライバーを表す MessageConsumer オブジェクトのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION
  • XMS_X_INVALID_SELECTOR_EXCEPTION

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

インターフェース:
xmsRC xmsSessCreateMapMessage(xmsHSess session,
xmsHMsg *message,
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。
message (出力)
マップ・メッセージのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsSessCreateMessage – メッセージの作成

インターフェース:
xmsRC xmsSessCreateMessage(xmsHSess session,
xmsHMsg *message,
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。
message (出力)
メッセージのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsSessCreateObjectMessage(xmsHSess session,
xmsHMsg *message,
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。
message (出力)
メッセージ・メッセージのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsSessCreateProducer(xmsHSess session,
xmsHDest destination,
xmsHMsgProducer *producer,
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。
destination (入力)
宛先のハンドル。

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

producer (出力)
メッセージ・プロデューサーのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION

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

インターフェース:
xmsRC xmsSessCreateStreamMessage(xmsHSess session,
xmsHMsg *message,
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。
message (出力)
ストリーム・メッセージのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsSessCreateTextMessage(xmsHSess session,
xmsHMsg *message,
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。
message (出力)
テキスト・メッセージのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsSessCreateTextMessageInit(xmsHSess session,
xmsCHAR *text
xmsINT length
xmsHMsg *message,
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。
text (入力)
テキスト・メッセージの本体を初期化するためのテキストを含む文字配列。
length (入力)
テキストの長さ (バイト単位)。テキストがヌルで終了し、ヌル文字が埋め込まれていない場合、代わりに XMSC_CALCULATE_STRING_SIZE を指定して、XMS が長さを計算できるようにすることも可能です。
message (出力)
テキスト・メッセージのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsSessGetAcknowledgeMode(xmsHSess session,
xmsINT *acknowledgeMode,
xmsHErrorBlock errorBlock);

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

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

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

パラメーター:
session (入力)
セッションのハンドル。
acknowledgeMode (出力)
肯定応答モード。セッションが処理されていない場合、肯定応答モードは以下の値のいずれかです。
  • XMSC_AUTO_ACKNOWLEDGE
  • XMSC_CLIENT_ACKNOWLEDGE
  • XMSC_DUPS_OK_ACKNOWLEDGE
セッションが処理された場合、関数は代わりに XMSC_SESSION_TRANSACTED を戻します。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsSessGetTransacted(xmsHSess session,
xmsBOOL *transacted,
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。
transacted (出力)
セッションが処理済みの場合、値は xmsTRUE です。セッションが処理されていない場合、値は xmsFALSE です。

ブローカーへのリアルタイム接続の場合、常に値は xmsFALSE です。

errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsSessRecover – 回復

インターフェース:
xmsRC xmsSessRecover(xmsHSess session,
xmsHErrorBlock errorBlock);

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

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

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

パラメーター:
session (入力)
セッションのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_ILLEGAL_STATE_EXCEPTION

xmsSessRollback – ロールバック

インターフェース:
xmsRC xmsSessRollback(xmsHSess session,
xmsHErrorBlock errorBlock);

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

パラメーター:
session (入力)
セッションのハンドル。セッションは、処理済みセッションでなければなりません。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_ILLEGAL_STATE_EXCEPTION

xmsSessUnsubscribe – アンサブスクライブ

インターフェース:
xmsRC xmsSessUnsubscribe(xmsHSess session,
xmsCHAR *subscriptionName,
xmsHErrorBlock errorBlock);

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

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

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

パラメーター:
session (入力)
セッションのハンドル。
subscriptionName (入力)
永続サブスクリプションを識別する名前。名前はヌル終了ストリング形式です。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • 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)