Ucs_Rm_ReportCb_t report_fptr

Optional report callback function pointer for all routes.

Note

The passed result callback function does not only report the result of the build operation but also monitors the status of the created routes during their whole lifetime. That is, the callback function also reports the various states of a route (Refer to Ucs_Rm_RouteInfos_t for more infos). Furthermore the result of Ucs_Rm_SetRouteActive() function call is reported by this result callback function.

Example

Ucs_InitData_t ucs_init_data;
(void)Ucs_SetDefaultConfig(&ucs_init_data);

// Routing Management init section.
ucs_init_data.rm.report_fptr = &App_OnRoutingResult;

// The report callback function for all routes
static void App_OnRoutingResult(uint16_t route_id, Ucs_Rm_RouteInfos_t route_infos, void *user_ptr)
{
    // Do whatever is necessary here

    switch (route_infos)
    {
        case UCS_RM_ROUTE_INFOS_BUILT:
           // Route has been built
           break;
        case UCS_RM_ROUTE_INFOS_DESTROYED:
           // Route has been destroyed
           break;
         case UCS_RM_ROUTE_INFOS_PROCESS_STOP:
           // Route cannot be processed anymore due to UNICENS Termination
           break;
         default:
           // Route has been suspended
           break;
    }
}