セッションとは、メッセージ送受信の単一スレッド・コンテキストです。
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 | 永続サブスクリプションを削除します。 |
xmsVOID close();
セッションを閉じます。セッションが処理済みの場合、進行中のトランザクションはロールバックされます。
セッションに従属するすべてのオブジェクトが削除されます。どのオブジェクトが削除されるかについては、オブジェクトの削除を参照してください。
アプリケーションが、既に閉じているセッションを閉じようとした場合、呼び出しは無視されます。
QueueBrowser createBrowser(const Destination & queue const String & messageSelector) const;
メッセージ・セレクターを使用して、指定されたキューのキュー・ブラウザーを作成します。
String オブジェクトがヌルであるとは、キュー・ブラウザー用のメッセージ・セレクターが存在しないという意味です。
MessageConsumer createConsumer(const Destination & destination, const String & messageSelector) const;
メッセージ・セレクターを使用して、指定された宛先のメッセージ・コンシューマーを作成します。
String オブジェクトがヌルであるとは、メッセージ・コンシューマー用のメッセージ・セレクターが存在しないという意味です。
MessageConsumer createConsumer(const Destination & destination, const String & messageSelector, const xmsBOOL noLocal) const;
メッセージ・セレクターを使用し、宛先がトピックの場合はメッセージ・コンシューマーが自身の接続により公開されたメッセージを受信するかどうかを指定して、指定された宛先のメッセージ・コンシューマーを作成します。
String オブジェクトがヌルであるとは、メッセージ・コンシューマー用のメッセージ・セレクターが存在しないという意味です。
MessageConsumer createDurableSubscriber(const Destination & topic, const String & subscriptionName) const;
ブローカーへのリアルタイム接続の場合、このメソッドは無効です。
永続サブスクライバーについて詳しくは、永続サブスクライバーを参照してください。
MessageConsumer createDurableSubscriber(const Destination & topic, const String & subscriptionName; const String & messageSelector, const xmsBOOL noLocal) const;
メッセージ・セレクターを使用し、永続サブスクライバーが自身の接続により公開されたメッセージを受信するかどうかを指定して、指定されたトピックの永続サブスクライバーを作成します。
ブローカーへのリアルタイム接続の場合、このメソッドは無効です。
永続サブスクライバーについて詳しくは、永続サブスクライバーを参照してください。
String オブジェクトがヌルであるとは、永続サブスクライバー用のメッセージ・セレクターが存在しないという意味です。
MessageProducer createProducer(const Destination & destination) const;
メッセージを指定された宛先へ送信するメッセージ・プロデューサーを作成します。
ヌルの Destination オブジェクトを指定すると、宛先のないメッセージ・プロデューサーが作成されます。 この場合アプリケーションは、メッセージを送信するためにメッセージ・プロデューサーを使用するたびに、宛先を指定する必要があります。
Destination createQueue(const String & queueName) const;
メッセージング・サーバー内のキューを表すための Destination オブジェクトを作成します。
このメソッドは、メッセージング・サーバー内にキューを作成しません。 アプリケーションがこのメソッドを呼び出すためには、その前にキューを作成する必要があります。
Destination createTemporaryQueue() const;
一時キューのスコープは接続です。接続によって作成されたセッションのみが、一時キューを使用できます。
一時キューは、明示的に削除されるまで、あるいは接続が終了するまで存続します。
一時キューについて詳しくは、一時宛先を参照してください。
Destination createTemporaryTopic() const;
一時トピックのスコープは接続です。接続によって作成されたセッションのみが、一時トピックを使用できます。
一時トピックは、明示的な削除または接続終了のいずれかが発生するまで存在します。
一時トピックについて詳しくは、一時宛先を参照してください。
xmsINT getAcknowledgeMode() const;
セッションの肯定応答モードを取得します。肯定応答モードは、セッション作成時に指定されます。
処理済みのセッションには、肯定応答モードはありません。
肯定応答モードについて詳しくは、セッションでのメッセージの受信の確認を参照してください。
xmsVOID recover() const;
セッションを回復します。メッセージ配信が一旦停止され、その後応答されていない最も古いメッセージを使用して再開されます。
セッションは、処理済みセッションであってはなりません。
セッションの回復について詳しくは、セッションでのメッセージの受信の確認を参照してください。
xmsVOID unsubscribe(const String & subscriptionName) const;
永続サブスクリプションを削除します。メッセージング・サーバーは 維持している永続サブスクリプションのレコードを削除し、これ以降永続サブスクライバーにメッセージを送信 しなくなります。
ブローカーへのリアルタイム接続の場合、このメソッドは無効です。