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

MessageConsumer

應用程式會使用訊息使用端來接收送往目的地的訊息。

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

有關 XMS 所定義的 MessageConsumer 物件內容清單, 請參閱MessageConsumer 內容

方法

方法摘要:
方法 說明
close 關閉訊息使用端。
getHandle 取得 C 應用程式在存取訊息使用端時所要使用的控點。
getMessageListener 取得已向訊息使用端登錄之訊息接聽器的指標。
getMessageSelector 取得訊息使用端的訊息選取器。
isNull 判斷 MessageConsumer 物件是否為一個空值物件。
receive 接收訊息使用端的下一則訊息。呼叫會無限期地等待訊息,或直到訊息使用端關閉為止。
receive 接收訊息使用端的下一則訊息。呼叫只等待訊息一段指定的時間,或直到訊息使用端關閉為止。
receiveNoWait 接收訊息使用端的下一則訊息(若立即有的話)。
setMessageListener 向訊息使用端登錄訊息接聽器。

close – 關閉訊息使用端

介面:
xmsVOID close();

關閉訊息使用端。

如果應用程式試著關閉已關閉的訊息使用端, 則會忽略該呼叫。

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

getHandle – 取得控點

介面:
xmsHMsgConsumer getHandle() const;

取得 C 應用程式在存取訊息使用端時所要使用的控點。

參數:
傳回:
訊息使用端的控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getMessageListener – 取得訊息接聽器

介面:
MessageListener * getMessageListener() const;

取得已向訊息使用端登錄之訊息接聽器的指標。

如需使用訊息接聽器的相關資訊, 請參閱在 C++ 中使用訊息接聽器

參數:
傳回:
訊息接聽器的指標。如果沒有任何訊息接聽器向訊息使用端登錄, 則方法會傳回空值指標。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getMessageSelector – 取得訊息選取器

介面:
String getMessageSelector() const;

取得訊息使用端的訊息選取器。

參數:
傳回:
封裝訊息選取器表示式的 String 物件。如果需要轉換資料, 則此為轉換後的訊息選取器表示式。如果訊息使用端沒有訊息選取器,則方法會傳回空值 String 物件。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

isNull – 檢查是否為空值

介面:
xmsBOOL isNull() const;

判斷 MessageConsumer 物件是否為一個空值物件。

參數:
傳回:
  • 如果 MessageConsumer 物件為空值物件,則為 xmsTRUE
  • 如果 MessageConsumer 物件不是空值物件,則為 xmsFALSE
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

receive – 接收

介面:
Message * receive() const;

接收訊息使用端的下一則訊息。呼叫會無限期地等待訊息,或直到訊息使用端關閉為止。

參數:
傳回:
Message 物件的指標。在呼叫等待訊息期間,如果訊息使用端已關閉, 則方法會傳回空值 Message 物件的指標。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

receive – 接收(有一個等待間隔)

介面:
Message * receive(const xmsLONG waitInterval) const;

接收訊息使用端的下一則訊息。呼叫只等待訊息一段指定的時間,或直到訊息使用端關閉為止。

參數:
waitInterval(輸入)
呼叫等待訊息的時間(毫秒)。如果您指定的等待間隔為 0, 呼叫會無限期地等待訊息。
傳回:
Message 物件的指標。在等待間隔期間,如果沒有訊息送達, 或者在呼叫等待訊息期間訊息使用端已關閉, 則方法會傳回空值 Message 物件的指標,但不會擲出任何異常狀況。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

receiveNoWait – 接收但不等待

介面:
Message * receiveNoWait() const;

接收訊息使用端的下一則訊息(若立即有的話)。

參數:
傳回:
Message 物件的指標。如果沒有訊息立即可用,方法會傳回空值 Message 物件的指標。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setMessageListener – 設定訊息接聽器

介面:
xmsVOID setMessageListener(const MessageListener *lsr);

向訊息使用端登錄訊息接聽器。

如需使用訊息接聽器的相關資訊, 請參閱在 C++ 中使用訊息接聽器

參數:
lsr(輸入)
訊息接聽器的指標。若有訊息接聽器已向訊息使用端登錄, 您可以改指定一個空值指標,以取消登錄。
傳回:
Void
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

繼承的方法


Reference topic

使用條款 | 評比此網頁

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