セッションとは、メッセージを送受信するための単一スレッドのコンテキストです。
セッションの XMS 定義プロパティーのリストについては、Session のプロパティーを参照してください。
関数 | 説明 |
---|---|
xmsSessClose | セッションを閉じます。 |
xmsSessCommit | 現在のトランザクションで処理されたすべてのメッセージをコミットします。 |
xmsSessCreateBrowser | 指定されたキューのキュー・ブラウザーを作成します。 |
xmsSessCreateBrowserSelector | メッセージ・セレクターを使用して、指定されたキューのキュー・ブラウザーを作成します。 |
xmsSessCreateBytesMessage | バイト・メッセージを作成します。 |
xmsSessCreateConsumer | 指定された宛先のメッセージ・コンシューマーを作成します。 |
xmsSessCreateConsumerSelector | メッセージ・セレクターを使用して、指定された宛先のメッセージ・コンシューマーを作成します。 |
xmsSessCreateConsumerSelectorLocal | メッセージ・セレクターを使用し、宛先がトピックの場合はメッセージ・コンシューマーが自身の接続により公開されたメッセージを受信するかどうかを指定して、指定された宛先のメッセージ・コンシューマーを作成します。 |
xmsSessCreateDurableSubscriber | 指定されたトピックの永続サブスクライバーを作成します。 |
xmsSessCreateDurableSubscriberSelector | メッセージ・セレクターを使用し、永続サブスクライバーが自身の接続により公開されたメッセージを受信するかどうかを指定して、指定されたトピックの永続サブスクライバーを作成します。 |
xmsSessCreateMapMessage | マップ・メッセージを作成します。 |
xmsSessCreateMessage | 本体を持たないメッセージを作成します。 |
xmsSessCreateObjectMessage | オブジェクト・メッセージを作成します。 |
xmsSessCreateProducer | メッセージを指定された宛先へ送信するメッセージ・プロデューサーを作成します。 |
xmsSessCreateStreamMessage | ストリーム・メッセージを作成します。 |
xmsSessCreateTextMessage | 本体が空であるテキスト・メッセージを作成します。 |
xmsSessCreateTextMessageInit | 本体が指定されたテキストで初期化されているテキスト・メッセージを作成します。 |
xmsSessGetAcknowledgeMode | セッションの肯定応答モードを取得します。 |
xmsSessGetTransacted | セッションが処理済みであるかどうかを判別します。 |
xmsSessRecover | セッションを回復します。 |
xmsSessRollback | 現在のトランザクションで処理されたすべてのメッセージをロールバックします。 |
xmsSessUnsubscribe | 永続サブスクリプションを削除します。 |
xmsRC xmsSessClose(xmsHSess *session, xmsHErrorBlock errorBlock);
セッションを閉じます。セッションが処理済みの場合、進行中のトランザクションはロールバックされます。
セッションに従属するすべてのオブジェクトが削除されます。どのオブジェクトが削除されるかについては、オブジェクトの削除を参照してください。
アプリケーションが、既に閉じているセッションを閉じようとした場合、呼び出しは無視されます。
xmsRC xmsSessCommit(xmsHSess session, xmsHErrorBlock errorBlock);
現在のトランザクションで処理されたすべてのメッセージをコミットします。
xmsRC xmsSessCreateBrowser(xmsHSess session, xmsHDest queue, xmsHQueueBrowser *browser xmsHErrorBlock errorBlock);
xmsRC xmsSessCreateBrowserSelector(xmsHSess session, xmsHDest queue, xmsCHAR *messageSelector, xmsINT length, xmsHQueueBrowser *browser xmsHErrorBlock errorBlock);
メッセージ・セレクターを使用して、指定されたキューのキュー・ブラウザーを作成します。
ヌルの値または空ストリングである場合は、キュー・ブラウザーのメッセージ・セレクターがないことを意味します。
xmsRC xmsSessCreateConsumer(xmsHSess session, xmsHDest destination, xmsHMsgConsumer *consumer, xmsHErrorBlock errorBlock);
xmsRC xmsSessCreateConsumerSelector(xmsHSess session, xmsHDest destination, xmsCHAR *messageSelector, xmsINT length, xmsHMsgConsumer *consumer, xmsHErrorBlock errorBlock);
メッセージ・セレクターを使用して、指定された宛先のメッセージ・コンシューマーを作成します。
ヌルの値または空ストリングである場合は、メッセージ・コンシューマーのメッセージ・セレクターがないことを意味します。
xmsRC xmsSessCreateConsumerSelectorLocal(xmsHSess session, xmsHDest destination, xmsCHAR *messageSelector, xmsINT length, xmsBOOL noLocal, xmsHMsgConsumer *consumer, xmsHErrorBlock errorBlock);
メッセージ・セレクターを使用し、宛先がトピックの場合はメッセージ・コンシューマーが自身の接続により公開されたメッセージを受信するかどうかを指定して、指定された宛先のメッセージ・コンシューマーを作成します。
ヌルの値または空ストリングである場合は、メッセージ・コンシューマーのメッセージ・セレクターがないことを意味します。
xmsRC xmsSessCreateDurableSubscriber(xmsHSess session, xmsHDest topic, xmsCHAR *subscriptionName xmsHMsgConsumer *subscriber, xmsHErrorBlock errorBlock);
ブローカーへのリアルタイム接続の場合、この関数は無効です。
永続サブスクライバーについて詳しくは、永続サブスクライバーを参照してください。
xmsRC xmsSessCreateDurableSubscriberSelector(xmsHSess session, xmsHDest topic, xmsCHAR *subscriptionName xmsCHAR *messageSelector, xmsINT length, xmsBOOL noLocal, xmsHMsgConsumer *subscriber, xmsHErrorBlock errorBlock);
メッセージ・セレクターを使用し、永続サブスクライバーが自身の接続により公開されたメッセージを受信するかどうかを指定して、指定されたトピックの永続サブスクライバーを作成します。
ブローカーへのリアルタイム接続の場合、この関数は無効です。
永続サブスクライバーについて詳しくは、永続サブスクライバーを参照してください。
ヌルの値または空ストリングである場合は、永続サブスクライバーのメッセージ・セレクターがないことを意味します。
xmsRC xmsSessCreateProducer(xmsHSess session, xmsHDest destination, xmsHMsgProducer *producer, xmsHErrorBlock errorBlock);
メッセージを指定された宛先へ送信するメッセージ・プロデューサーを作成します。
NULL ハンドルを指定すると、メッセージ・プロデューサーは宛先なしで作成されます。この場合、アプリケーションは、メッセージを送信するためにメッセージ・プロデューサーを使用するたびに、宛先を指定する必要があります。
xmsRC xmsSessCreateTextMessageInit(xmsHSess session, xmsCHAR *text xmsINT length xmsHMsg *message, xmsHErrorBlock errorBlock);
本体が指定されたテキストで初期化されているテキスト・メッセージを作成します。
xmsRC xmsSessGetAcknowledgeMode(xmsHSess session, xmsINT *acknowledgeMode, xmsHErrorBlock errorBlock);
セッションの肯定応答モードを取得します。肯定応答モードは、セッション作成時に指定されます。
処理済みのセッションには、肯定応答モードはありません。
肯定応答モードについて詳しくは、セッションでのメッセージの受信の確認を参照してください。
xmsRC xmsSessGetTransacted(xmsHSess session, xmsBOOL *transacted, xmsHErrorBlock errorBlock);
ブローカーへのリアルタイム接続の場合、常に値は xmsFALSE です。
xmsRC xmsSessRecover(xmsHSess session, xmsHErrorBlock errorBlock);
セッションを回復します。メッセージ配信が一旦停止され、その後応答されていない最も古いメッセージを使用して再開されます。
セッションは、処理済みセッションであってはなりません。
セッションの回復について詳しくは、セッションでのメッセージの受信の確認を参照してください。
xmsRC xmsSessUnsubscribe(xmsHSess session, xmsCHAR *subscriptionName, xmsHErrorBlock errorBlock);
永続サブスクリプションを削除します。メッセージング・サーバーが、保守している永続サブスクリプションのレコードを削除し、永続サブスクライバーにこれ以上メッセージを送信しなくなります。
ブローカーへのリアルタイム接続の場合、この関数は無効です。