发行说明

38.3 db2DatabasePing（新 API）

db2DatabasePing — Ping 数据库

测试客户机与数据库服务器之间的基本连接的网络响应时间。如果主机数据库服务器是直接通过 DB2 Connect 或通过网关访问的，则应用程序可使用此 API。

权限

无

必需的连接

数据库

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 Connect 产品的版本和发行版。

注意:

应对 DB2 版本 7.1 或更高版本使用常量 db2Version710 或更高值。

|pParmStruct

输入。指向“db2DatabasePingStruct 结构”的指针。

iDbAliasLength

输入。数据库别名的长度。

注意:

目前不使用此参数。它被留作将来使用。

iDbAlias

输入。数据库别名。

注意:

目前不使用此参数。它被留作将来使用。

iNumIterations

输入。测试请求迭代数。该值必须在 1 和 32767 之间，包括 1 和 32767。

poElapsedTime

输出。指向 32 位整数数组的指针，其中元素数等于 iNumIterations。该数组中的每个元素都将包含一个测试请求迭代的所用时间（以微秒计）。

注意:

应用程序负责在调用此 API 之前为此数组分配内存。

pSqlca

输出。指向 sqlca 结构的指针。有关此结构的更多信息，参见 Administrative API Reference。

使用说明

数据库连接必须存在，才能调用此 API，否则将会产生错误。

此函数还可使用 PING 命令来调用。有关此命令的描述，参见 命令参考。