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

Connection

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

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

函數

函數摘要:
函數 說明
xmsConnClose 關閉連線。
xmsConnCreateSession 建立階段作業。
xmsConnGetClientID 取得連線的用戶端 ID。
xmsConnGetExceptionListener 取得已向連線登錄之異常狀況接聽器函數和環境定義資料的指標。
xmsConnGetMetaData 取得連線的 meta 資料。
xmsConnSetClientID 設定連線的用戶端 ID。
xmsConnSetExceptionListener 向連線登錄異常狀況接聽器函數和環境定義資料。
xmsConnStart 針對連線啟動或重新啟動送入訊息的遞送。
xmsConnStop 針對連線停止送入訊息的遞送。

xmsConnClose – 關閉連線

介面:
xmsRC xmsConnClose(xmsHConn *connection,
                   xmsHErrorBlock errorBlock);

關閉連線。

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

參數:
connection(輸入/輸出)
在輸入方面,為連線的控點。在輸出方面,函數會傳回空值控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsConnCreateSession – 建立階段作業

介面:
xmsRC xmsConnCreateSession(xmsHConn connection,
                           xmsBOOL transacted,
                           xmsINT acknowledgeMode,
                           xmsHSess *session,
                           xmsHErrorBlock errorBlock);

建立階段作業。

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

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

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

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

session(輸出)
階段作業的控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsConnGetClientID – 取得用戶端 ID

介面:
xmsRC xmsConnGetClientID(xmsHConn connection,
                         xmsCHAR *clientID,
                         xmsINT length,
                         xmsINT *actualLength,
                         xmsHErrorBlock errorBlock);

取得連線的用戶端 ID。

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

如需如何使用此函數的相關資訊, 請參閱會以值形式來傳回字串的 C 函數

參數:
connection(輸入)
連線的控點。
clientID(輸出)
內含用戶端 ID 的緩衝區。
length(輸入)
緩衝區的長度(以位元組計)。如果您指定的是 XMSC_QUERY_SIZE, 則不會傳回用戶端 ID,而會將其長度放在 actualLength 參數中傳回。
actualLength(輸出)
用戶端 ID 的長度(以位元組計)。如果需要轉換資料, 則此為轉換後的用戶端 ID 長度。如果您在輸入中指定一個空值指標, 則不會傳回長度。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsConnGetExceptionListener – 取得異常狀況接聽器

介面:
xmsRC xmsConnGetExceptionListener(xmsHConn connection,
                                  fpXMS_EXCEPTION_CALLBACK *lsr,
                                  xmsCONTEXT *context,
                                  xmsHErrorBlock errorBlock);

取得已向連線登錄之異常狀況接聽器函數和環境定義資料的指標。

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

參數:
connection(輸入)
連線的控點。
lsr(輸出)
異常狀況接聽器函數的指標。如果沒有任何異常狀況接聽器函數向連線登錄, 則呼叫會傳回空值指標。
context(輸出)
環境定義資料的指標。如果沒有任何異常狀況接聽器函數向連線登錄, 則呼叫會傳回空值指標。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsConnGetMetaData – 取得 meta 資料

介面:
xmsRC xmsConnGetMetaData(xmsHConn connection,
                         xmsHConnMetaData *connectionMetaData,
                         xmsHErrorBlock errorBlock);

取得連線的 meta 資料。

參數:
connection(輸入)
連線的控點。
connectionMetaData(輸出)
連線 meta 資料的控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsConnSetClientID – 設定用戶端 ID

介面:
xmsRC xmsConnSetClientID(xmsHConn connection,
                         xmsCHAR *clientID,
                         xmsINT length,
                         xmsHErrorBlock errorBlock)

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

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

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

參數:
connection(輸入)
連線的控點。
clientID(輸入)
字元陣列形式的用戶端 ID。
length(輸入)
用戶端 ID 的長度(以位元組計)。如果用戶端 ID 在沒有內嵌空值字元下空值終止, 您可以指定 XMSC_CALCULATE_STRING_SIZE,以容許 XMS 計算其長度。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_ILLEGAL_STATE_EXCEPTION
  • XMS_X_INVALID_CLIENTID_EXCEPTION

xmsConnSetExceptionListener – 設定異常狀況接聽器

介面:
xmsRC xmsConnSetExceptionListener(xmsHConn connection,
                                  fpXMS_EXCEPTION_CALLBACK lsr,
                                  xmsCONTEXT context,
                                  xmsHErrorBlock errorBlock);

向連線登錄異常狀況接聽器函數和環境定義資料。

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

參數:
connection(輸入)
連線的控點。
lsr(輸入)
異常狀況接聽器函數的指標。若有異常狀況接聽器函數已向連線登錄, 您可以改指定一個空值指標,以取消登錄。
context(輸入)
環境定義資料的指標。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsConnStart – 啟動連線

介面:
xmsRC xmsConnStart(xmsHConn connection,
                   xmsHErrorBlock errorBlock);

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

參數:
connection(輸入)
連線的控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsConnStop – 停止連線

介面:
xmsRC xmsConnStop(xmsHConn connection,
                  xmsHErrorBlock errorBlock);

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

參數:
connection(輸入)
連線的控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

Reference topic

使用條款 | 評比此網頁

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