WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 作業系統: Linux, Windows

Session

階段作業為傳送和接收訊息時所用的一種單一執行緒環境定義。

繼承階層:
xms::PropertyContext
   |
   +----xms::Session

有關 XMS 所定義的 Session 物件內容清單, 請參閱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 回復 (recove)階段作業。
rollback 回復 (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(輸入)
封裝佇列名稱或封裝用以識別該佇列之統一資源識別碼 (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(輸入)
封裝主題名稱或封裝用以識別該主題之統一資源識別碼 (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 – 回復 (recove)

介面:
xmsVOID recover() const;

回復 (recove)階段作業。訊息遞送會停止, 然後使用最舊的未確認訊息重新啟動。

階段作業不得為交易式階段作業。

如需回復 (recove)階段作業的相關資訊, 請參閱在階段作業中確認收到訊息

參數:
傳回:
Void
異常狀況:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_ILLEGAL_STATE_EXCEPTION

rollback – 回復 (Rollback)

介面:
xmsVOID rollback() const;

回復 (Rollback)現行交易中所有已處理的訊息。

階段作業必須是交易式階段作業。

參數:
傳回:
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

使用條款 | 評比此網頁

時間戳記前次更新: 25 Apr 2006
(C) Copyright IBM Corporation 2005. All Rights Reserved.
本資訊中心採用 Eclipse 技術。(http://www.eclipse.org)