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

ISession

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

継承の階層:
IBM.XMS.IPropertyContext
|
+----IBM.XMS.ISession

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

.NET プロパティー

.NET プロパティーの要約:
.NET プロパティー 説明
AcknowledgeMode セッションの肯定応答モードを取得します。
Transacted セッションが処理済みであるかどうかを判別します。

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

インターフェース:
AcknowledgeMode AcknowledgeMode
{
get;
}

セッションの肯定応答モードを取得します。

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

セッションが処理されていない場合、肯定応答モードは以下の値のいずれかです。

  • AcknowledgeMode.AutoAcknowledge
  • AcknowledgeMode.ClientAcknowledge
  • AcknowledgeMode.DupsOkAcknowledge

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

処理済みのセッションには、肯定応答モードはありません。セッションが処理された場合、メソッドは代わりに AcknowledgeMode.SessionTransacted を戻します。

例外:
  • XMSException

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

インターフェース:
Boolean Transacted
{
get;
}

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

処理済みの状態は以下のとおりです。

  • セッションが処理されている場合は、True です。
  • セッションが処理されていない場合は、False です。

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

例外:
  • XMSException

メソッド

メソッドの要約:
メソッド 説明
Close セッションを閉じます。
Commit 現在のトランザクションで処理されたすべてのメッセージをコミットします。
CreateBrowser 指定されたキューのキュー・ブラウザーを作成します。
CreateBrowser メッセージ・セレクターを使用して、指定されたキューのキュー・ブラウザーを作成します。
CreateBytesMessage バイト・メッセージを作成します。
CreateConsumer 指定された宛先のメッセージ・コンシューマーを作成します。
CreateConsumer メッセージ・セレクターを使用して、指定された宛先のメッセージ・コンシューマーを作成します。
CreateConsumer メッセージ・セレクターを使用し、宛先がトピックの場合はメッセージ・コンシューマーが自身の接続により公開されたメッセージを受信するかどうかを指定して、指定された宛先のメッセージ・コンシューマーを作成します。
CreateDurableSubscriber 指定されたトピックの永続サブスクライバーを作成します。
CreateDurableSubscriber メッセージ・セレクターを使用し、永続サブスクライバーが自身の接続により公開されたメッセージを受信するかどうかを指定して、指定されたトピックの永続サブスクライバーを作成します。
CreateMapMessage マップ・メッセージを作成します。
CreateMessage 本体を持たないメッセージを作成します。
CreateObjectMessage オブジェクト・メッセージを作成します。
CreateProducer メッセージを指定された宛先へ送信するメッセージ・プロデューサーを作成します。
CreateQueue メッセージング・サーバー内のキューを表すための Destination オブジェクトを作成します。
CreateStreamMessage ストリーム・メッセージを作成します。
CreateTemporaryQueue 一時キューを作成します。
CreateTemporaryTopic 一時トピックを作成します。
CreateTextMessage 本体が空であるテキスト・メッセージを作成します。
CreateTextMessage 本体が指定されたテキストで初期化されているテキスト・メッセージを作成します。
CreateTopic トピックを表すための Destination オブジェクトを作成します。
Recover セッションを回復します。
Rollback 現在のトランザクションで処理されたすべてのメッセージをロールバックします。
Unsubscribe 永続サブスクリプションを削除します。

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

インターフェース:
void Close();

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

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

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

Commit – コミット

インターフェース:
void Commit();

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

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

パラメーター:
なし
戻り値:
void
例外:
  • XMSException
  • IllegalStateException
  • TransactionRolledBackException

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

インターフェース:
IQueueBrowser CreateBrowser(IDestination queue) ;

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

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

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

インターフェース:
IQueueBrowser CreateBrowser(IDestination queue, String selector) ;

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

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

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

戻り値:
QueueBrowser オブジェクト。
例外:
  • XMSException
  • InvalidDestinationException
  • InvalidSelectorException

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

インターフェース:
IBytesMessage CreateBytesMessage();

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

パラメーター:
なし
戻り値:
BytesMessage オブジェクト。
例外:
  • XMSException
  • IllegalStateException (セッションは終了しています)

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

インターフェース:
IMessageConsumer CreateConsumer(IDestination dest) ;

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

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

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

インターフェース:
IMessageConsumer CreateConsumer(IDestination dest,
String selector) ;

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

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

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

戻り値:
MessageConsumer オブジェクト。
例外:
  • XMSException
  • InvalidDestinationException
  • InvalidSelectorException

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

インターフェース:
IMessageConsumer CreateConsumer(IDestination dest,
String selector,
Boolean noLocal) ;

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

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

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

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

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

インターフェース:
IMessageConsumer CreateDurableSubscriber(IDestination dest,
String subscription) ;

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

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

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

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

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

インターフェース:
IMessageConsumer CreateDurableSubscriber(IDestination dest,
String subscription,
String selector,
Boolean noLocal) ;

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

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

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

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

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

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

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

インターフェース:
IMapMessage CreateMapMessage();

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

パラメーター:
なし
戻り値:
MapMessage オブジェクト。
例外:
  • XMSException
  • IllegalStateException (セッションは終了しています)

CreateMessage – メッセージの作成

インターフェース:
IMessage CreateMessage();

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

パラメーター:
なし
戻り値:
Message オブジェクト。
例外:
  • XMSException
  • IllegalStateException (セッションは終了しています)

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

インターフェース:
IObjectMessage CreateObjectMessage();

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

パラメーター:
なし
戻り値:
ObjectMessage オブジェクト。
例外:
  • XMSException
  • IllegalStateException (セッションは終了しています)

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

インターフェース:
IMessageProducer CreateProducer(IDestination dest) ;

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

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

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

戻り値:
MessageProducer オブジェクト。
例外:
  • XMSException
  • InvalidDestinationException

CreateQueue – キューの作成

インターフェース:
IDestination CreateQueue(String queue) ;

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

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

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

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

インターフェース:
IStreamMessage CreateStreamMessage();

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

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

CreateTemporaryQueue – 一時キューの作成

インターフェース:
IDestination CreateTemporaryQueue() ;

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

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

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

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

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

CreateTemporaryTopic – 一時トピックの作成

インターフェース:
IDestination CreateTemporaryTopic() ;

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

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

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

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

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

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

インターフェース:
ITextMessage CreateTextMessage();

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

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

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

インターフェース:
ITextMessage CreateTextMessage(String initialValue);

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

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

CreateTopic – トピックの作成

インターフェース:
IDestination CreateTopic(String topic) ;

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

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

Recover – 回復

インターフェース:
void Recover();

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

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

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

パラメーター:
なし
戻り値:
void
例外:
  • XMSException
  • IllegalStateException

Rollback – ロールバック

インターフェース:
void Rollback();

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

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

パラメーター:
なし
戻り値:
void
例外:
  • XMSException
  • IllegalStateException

Unsubscribe – アンサブスクライブ

インターフェース:
void Unsubscribe(String subscription);

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

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

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

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

継承されたプロパティーおよびメソッド


Reference topic

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

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