iscEngineListenerPF

Finalidad

iscEngineListenerPF define el prototipo con que debe cumplir la función de escucha definida por el usuario registrada en iscEngineSetListener().

Sintaxis

typedef isy_INT32 (*iscEngineListenerPF)(
    isy_UINT32  listenerData,
    ISCEVT*     event,
    isy_VOID*   pExtraInfo);

Argumentos de la función

La Tabla 139 lista los argumentos válidos utilizados con el tipo de función iscEngineSetListenerPF.

Tabla 139. Argumentos de iscEngineListenerPF

Uso

Para utilizar una función de escucha definida por el usuario para supervisar el progreso de la sincronización, antes debe hacer que la función cumpla con el tipo de función iscEngineSetListenerPF. A continuación, registre la función de escucha mediante la función iscEngineSetListener(). Luego, se notificará a la función de escucha cuando se produzcan sucesos de sincronización. El argumento event es una estructura que contiene informaciones diversas sobre el suceso.

La Tabla 140 lista todos los campos de la estructura de sucesos y la finalidad de cada campo.

Tabla 140. Campos de suceso de iscEngineListenerPF

El campo event.info contiene cierta información opcional específica del suceso. El código de suceso se utiliza para identificar e interpretar esta información.

La Tabla 141 lista todos los códigos de suceso por categoría de tipo de suceso.

Tabla 141. Códigos de suceso de iscEngineListenerPF

Tabla 142. Códigos de suceso de iscEngineListenerPF

Tabla 143. Códigos de suceso de iscEngineListenerPF

Tabla 144. Códigos de suceso de iscEngineListenerPF

Tabla 145. Códigos de suceso de iscEngineListenerPF

Tabla 146. Códigos de suceso de iscEngineListenerPF

Ejemplo:

isy_INT32 mySyncListener(
    isy_UINT32 listenerData,
    ISCEVT*     event,
    isy_VOID*  pExtraInfo)
{
    char *statusMsg = appEventCodeToMessage(event);
    int   timesRetried;
 
    switch (event->type) {
      case ISCEVTTYPE_Info:
        appStatusBar(statusMsg);
        // appStatusBar puede ser cualquier rutina que muestre el statusMsg
        // (por ejemplo, en una barra de estado)
                return ISCRTNCB_Done;
 
      case ISCEVTTYPE_Retry:
        timesRetried = event->retry;
        if (timesRetried >= 3) // Intentar como máximo 3 veces
            return ISCRTNCB_ReplyNo;
        else
            return appRetryCancelBox(statusMsg, 10); // tiempo de espera 10 seg
        // appRetryCancelBox puede ser cualquier rutina que muestre una ventana
        // con dos botones: Cancelar y Reintentar. Devuelve
        //   ISCRTNCB_ReplyYes, si el usuario pulsa Reintentar
        //   ISCRTNCB_ReplyNo, si el usuario pulsa Cancelar
        // Si el usuario no hace una selección, devuelve ISCRTNCB_Default.
          break;
 
        // todos los otros tipos de suceso no importan
				  default:
        return ISCRTNCB_Default;
    } // switch (event->type)
} // mySyncListener

Códigos de retorno

• ISCRTNCB_ReplyYes : El usuario responde Sí a la consulta.
• ISCRTNCB_ReplyNo* : El usuario responde No a la consulta.
• ISCRTNCB_Default : No hay respuesta; emprender la acción por omisión.

Si el tipo de suceso es ISCEVTTYPE_Retry, la función de escucha devuelve uno de los códigos siguientes:

Si el tipo de suceso es ISCEVTTYPE_Query, el significado del código de retorno depende del valor del código del suceso. En otras palabras, la función de escucha comprueba el código del suceso y devuelve el valor apropiado. Pero, si el usuario no responde a la consulta, la aplicación devuelve el código siguiente:

• ISCRTNCB_Default : No hay respuesta; emprender la acción por omisión.

Para los tipos de suceso distintos de ISCEVTTYPE_Retry e ISCEVTTYPE_Query, el motor de sincronización ignora el código de retorno. La función de escucha simplemente devuelve ISCRTNCB_Done.

Nota: Para aquellos sucesos que no son de interés, la función de escucha simplemente devuelve ISCRTNCB_Default y permite que el motor de sincronización emprenda la acción por omisión.

Nota: Un asterisco (*) encima indica la acción por omisión para diversos tipos de suceso.

Restricciones

La función de escucha definida por el usuario debe seguir el protocolo del motor de sincronización. En caso contrario, es posible que el motor de sincronización no funcione correctamente.

Conceptos relacionados

• La aplicación Sync Client C/C++ de ejemplo

Tareas relacionadas

• Desarrollo de aplicaciones DB2 Everyplace Sync Client utilizando C/C++

Consulta relacionada

• Comparaciones entre la API C de IBM Sync Client Versión 8.1 y la Versión 7.2
• Tipos de datos de la API C de IBM Sync Client
• Resumen de funciones de la API C de IBM Sync Client
• iscEngineSync()
• iscEngineSetListener()