tibemsMulticastExceptionCallback

Function Type

Warning: Along with the multicast feature, this function was deprecated in software release 8.3.0 and will no longer be supported in future releases.

Purpose

Programs define functions of this type to asynchronously detect conditions with EMS multicast that may affect message consumers.

C Declaration

typedef void (*tibemsMulticastExceptionCallback) (
    tibemsConnection connection,
    tibemsSession session,
    tibemsMsgConsumer consumer,
    tibems_status status,
    const char* description,
    void* closure);

Parameters

Parameter Description
connection Receive the connection object.
session Receive the session object.
consumer Receive the consumer object.
status Receive a status code, which identifies the multicast problem.
description Receive a text description describing the multicast problem.
closure Receive the closure data, which the program supplied in the call that registered the callback.

Remarks

When a program uses a multicast consumer to receive messages, EMS can detect conditions that may indicate a problem, and notify the client program by returning an error status code. The client application can then take the appropriate action.

This callback provides a pathway for alerting a client program of multicast problems. The program implements this callback and registers it. When the client library detects a multicast problem, it calls this callback and passes it the appropriate EMS objects, a status code that identifies the problem, and a detailed description of the problem.

This callback is invoked for each consumer that is affected by the multicast warning or error. Some applications may just simply log the problem; others may take further measures.

This call is not supported in COBOL, and is not supported on z/OS and IBM i systems.