リリース情報

37.3 db2DatabasePing (新規 API)

db2DatabasePing - データベースの Ping

クライアントとデータベース・サーバーの間の基礎接続のネットワーク応答時間をテストします。この API は、ホスト・データベース・サーバーが、直接またはゲートウェイ経由で DB2 コネクトからアクセスされるときにアプリケーションによって使用されます。

権限

なし

必要な接続

データベース

API 組み込みファイル

db2ApiDf.h

C API 構文

   /* File: db2ApiDf.h */
   /* API: Ping Database */
   /* ... */
 
 
   SQL_API_RC SQL_API_FN
     db2DatabasePing (
     db2Uint32 versionNumber,
         void         *pParmStruct,
     struct sqlca * pSqlca);
   /* ... */
 
   typedef SQL_STRUCTURE db2DatabasePingStruct
   {
     char          iDbAlias[SQL_ALIAS_SZ + 1];  
     db2Uint16     iNumIterations;
     db2Uint32    *poElapsedTime;
   }

汎用 API 構文

/* File: db2ApiDf.h */
   /* API: Ping Database */
   /* ... */
   SQL_API_RC SQL_API_FN
     db2gDatabasePing (
     db2Uint32 versionNumber,
         void         *pParmStruct,
     struct sqlca * pSqlca);
   /* ... */
 
   typedef SQL_STRUCTURE db2gDatabasePingStruct
   {
     db2Uint16     iDbAliasLength;
     char          iDbAlias[SQL_ALIAS_SZ]; 
     db2Uint16     iNumIterations;
     db2Uint32    *poElapsedTime;
   }

API パラメーター

versionNumber

入力。アプリケーションが使用している DB2 ユニバーサル・データベースまたは DB2 コネクト製品のバージョンとリリース番号を示します。

注:

定数 db2Version710 あるいはそれ以降が、DB2 バージョン 7.1 あるいはそれ以降に対して使用されます。

|pParmStruct

入力。db2DatabasePingStruct 構造へのポインター。

iDbAliasLength

入力。データベース別名の長さを示します。

注:

このパラメーターは現在使用されていません。将来の利用のために予約してあります。

iDbAlias

入力。データベース別名を示します。

注:

このパラメーターは現在使用されていません。将来の利用のために予約してあります。

iNumIterations

入力。テスト要求反復数を示します。値は、 1 から 32767 までにしてください。

poElapsedTime

出力。 エレメントの数が iNumIterations に等しい 32 ビット配列へのポインターを示します。配列の各エレメントには、 1 つのテスト要求反復用に、マイクロ秒単位の経過時間が含まれます。

注:

アプリケーションは、この API を呼び出す前に、この配列へのメモリー割り振りについての責任を負います。

pSqlca

出力。 sqlca 構造へのポインター。この構造体の詳細について詳しくは、管理 API 解説書 をご覧ください。

使用上の注意

データベース接続は、この API を呼び出す前に存在している必要があります。存在していない場合、エラーが起きます。

この関数は、PING コマンドを使用して呼び出すこともできます。このコマンドの説明については、コマンド解説書 をご覧ください。