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

Connection

Connection 物件代表一條應用程式至分配管理系統的作用中連線。

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

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

方法

方法摘要:
方法 說明
close 關閉連線。
createSession 建立階段作業。
getClientID 取得連線的用戶端 ID。
getExceptionListener 取得已向連線登錄之異常狀況接聽器的指標。
getHandle 取得 C 應用程式在存取連線時所要使用的控點。
getMetaData 取得連線的 meta 資料。
isNull 判斷 Connection 物件是否為一個空值物件。
setClientID 設定連線的用戶端 ID。
setExceptionListener 向連線登錄異常狀況接聽器。
start 針對連線啟動或重新啟動送入訊息的遞送。
stop 針對連線停止送入訊息的遞送。

close – 關閉連線

介面:
xmsVOID close();

關閉連線。

如果應用程式試著關閉已關閉的連線, 則會忽略該呼叫。

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

createSession – 建立階段作業

介面:
Session createSession(const xmsBOOL transacted,
                      const xmsINT acknowledgeMode);

建立階段作業。

參數:
transacted(輸入)
xmsTRUE 表示階段作業為交易式。值 xmsFALSE 表示階段作業不是交易式。

若為和分配管理系統間的即時連線, 此值必須是 xmsFALSE

acknowledgeMode(輸入)
指出如何確認應用程式所接收的訊息。此值必須是下列一種確認模式:
  • XMSC_AUTO_ACKNOWLEDGE
  • XMSC_CLIENT_ACKNOWLEDGE
  • XMSC_DUPS_OK_ACKNOWLEDGE
若為和分配管理系統間的即時連線, 此值必須是 XMSC_AUTO_ACKNOWLEDGEXMSC_DUPS_OK_ACKNOWLEDGE

如果階段作業為交易式, 則會忽略這個參數。如需確認模式的相關資訊,請參閱在階段作業中確認收到訊息

傳回:
Session 物件。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getClientID – 取得用戶端 ID

介面:
String getClientID() const;

取得連線的用戶端 ID。

此方法不適用於和分配管理系統間的即時連線。

參數:
傳回:
封裝用戶端 ID 的 String 物件。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getExceptionListener – 取得異常狀況接聽器

介面:
ExceptionListener * getExceptionListener() const;

取得已向連線登錄之異常狀況接聽器的指標。

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

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

getHandle – 取得控點

介面:
xmsHConn getHandle() const;

取得 C 應用程式在存取連線時所要使用的控點。

參數:
傳回:
連線的控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getMetaData – 取得 meta 資料

介面:
ConnectionMetaData getMetaData() const;

取得連線的 meta 資料。

參數:
傳回:
ConnectionMetaData 物件。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

isNull – 檢查是否為空值

介面:
xmsBOOL isNull() const;

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

參數:
傳回:
  • 如果 Connection 物件為空值物件,則為 xmsTRUE
  • 如果 Connection 物件不是空值物件,則為 xmsFALSE
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setClientID – 設定用戶端 ID

介面:
xmsVOID setClientID(const String & clientID);

設定連線的用戶端 ID。用戶端 ID 只用來在發佈/訂閱網域中支援延續訂閱, 若在點對點網域中則會被忽略。

如果應用程式呼叫此方法以便設定連線的用戶端 ID 時, 應用程式會在建立連線後旋即執行此作業,然後再對連線執行其他任何作業。如果應用程式在過了該時間點後才試著呼叫此方法, 則此方法會擲出 XMS_X_ILLEGAL_STATE_EXCEPTION 異常狀況。

此方法不適用於和分配管理系統間的即時連線。

參數:
clientID(輸入)
封裝用戶端 ID 的 String 物件。
傳回:
Void
異常狀況:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_ILLEGAL_STATE_EXCEPTION
  • XMS_X_INVALID_CLIENTID_EXCEPTION

setExceptionListener – 設定異常狀況接聽器

介面:
xmsVOID setExceptionListener(const ExceptionListener *lsr);

向連線登錄異常狀況接聽器。

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

參數:
lsr(輸入)
異常狀況接聽器的指標。

若有異常狀況接聽器已向連線登錄, 您可以改指定一個空值指標,以取消登錄。

傳回:
Void
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

start – 啟動連線

介面:
xmsVOID start() const;

針對連線啟動或重新啟動送入訊息的遞送。如果連線已啟動,則會忽略呼叫。

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

stop – 停止連線

介面:
xmsVOID stop() const;

針對連線停止送入訊息的遞送。如果連線已停止,則會忽略呼叫。

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

繼承的方法


Reference topic

使用條款 | 評比此網頁

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