Notas sobre o Release

37.3 db2DatabasePing (nova API)

db2DatabasePing - Banco de Dados para Execução de Ping

Testa o tempo de resposta da rede de conectividade subjacente entre um cliente e um servidor do bancos de dados. Esta API pode ser utilizada por um aplicativo quando um servidor do bancos de dados do host é acessado através do DB2 Connect, diretamente ou através de um gateway.

Autorização

Nenhum

Conexão Requerida

Banco de Dados

Arquivo de Inclusão da API

db2ApiDf.h

Sintaxe da API C

      /* Arquivo: 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;
   }

Sintaxe da API Genérica

   /* Arquivo: 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;
   }

Parâmetros da API

versionNumber

Entrada. Versão e release do produto DB2 Universal Database ou DB2 Connect que o aplicativo está utilizando.

Nota:

A constante db2Version710 ou superior deve ser usada para o DB2 Versão 7.1 ou superior.

pParmStruct

Entrada. Um ponteiro para a Estrutura db2DatabasePingStruct.

iDbAliasLength

Entrada. Comprimento do nome de alias do banco de dados.

Nota:

Este parâmetro não é utilizado atualmente. Ele está reservado para uso futuro.

iDbAlias

Entrada. Nome de alias do banco de dados.

Nota:

Este parâmetro não é utilizado atualmente. Ele está reservado para uso futuro.

iNumIterations

Entrada. Número de iterações de solicitação de teste. O valor deve estar entre 1 e 32767, inclusive.

poElapsedTime

Saída. Um indicador para uma matriz de inteiros de 32 bits em que o número de elementos seja igual a iNumIterations. Cada elemento na matriz conterá o tempo decorrido em microssegundos para uma iteração de solicitação de teste.

Nota:

O aplicativo é responsável pela alocação da memória para esta matriz antes de chamar esta API.

pSqlca

Saída. Um indicador para a estrutura sqlca. Para obter maiores informações sobre esta estrutura, consulte a publicação Administrative API Reference.

Notas de Uso

Deve existir uma conexão do banco de dados antes da chamada desta API, do contrário, ocorrerá um erro.

Esta função também pode ser chamada através do comando PING. Para obter uma descrição deste comando, consulte a publicação Command Reference.