Замечания по выпуску

37.3 db2DatabasePing (новый API)

db2DatabasePing - проверка связи с базой данных

Проверяет время ответа сети для соединения между клиентом и сервером баз данных. Этот API может использоваться любой программой, когда обращение к серверу баз данных хоста осуществляется через DB2 Connect, как напрямую, так и через шлюз.

Авторизация

Нет

Необходимое соединение

База данных

Файл включения API

db2ApiDf.h

Синтаксис API C

   /* Файл: db2ApiDf.h */
   /* API: Проверка соединения с базой данных */
   /* ... */
 
 
   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

   /* Файл: db2ApiDf.h */
   /* API: Проверка соединения с базой данных */
   /* ... */
   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 Universal Database или DB2 Connect, которые использует программа.

Прим.:

Для DB2 Версии 7.1 или новее должна использоваться константа db2Version710.

|pParmStruct

Входной. Указатель на структуру db2DatabasePingStruct.

iDbAliasLength

Входной. Длина алиаса базы данных.

Прим.:

Этот параметр сейчас не используется. Он зарезервирован для будущего использования.

iDbAlias

Входной. Алиас базы данных.

Прим.:

Этот параметр сейчас не используется. Он зарезервирован для будущего использования.

iNumIterations

Входной. Число повторений требований тестирования. Значение должно находиться в диапазоне от 1 до 32767 включительно.

poElapsedTime

Выходной. Указатель на массив 32-битных целых, число элементов равно значению iNumIterations. Каждый элемент в этом массиве будет содержать время в микросекундах, затраченное на одно выполнение требования тестирования.

Прим.:

За выделение памяти для этого массива перед вызовом данного API отвечает прикладная программа.

pSqlca

Выходной. Указатель на структуру sqlca. Дополнительную информацию об этой структуре смотрите в руководстве Administrative API Reference.

Замечания по использованию

Перед вызовом данного API соединение с базой данных должно существовать, иначе произойдет ошибка.

Эту функцию можно также вызвать при помощи команды PING. Описание этой команды смотрите в руководстве Command Reference.