Ucs_Return_t Ucs_Rm_SetRouteActive | ( | Ucs_Inst_t * | self, |
Ucs_Rm_Route_t * | route_ptr, | ||
bool | active | ||
) |
Sets the given route to active
respectively inactive
and triggers the routing process to handle the route.
When setting a route to active
the routing process will start building the route and all related resources and return the result to the user callback function (Refer to Routing Management Init Structure). When setting a route to inactive
the routing process will start destroying the route and all related resources and return the result to the user callback function.
self | The UNICENS instance. |
route_ptr | Reference to the routes to be destroyed. |
active | Specifies whether the route should be activated or not. true is active and false inactive. |
Value | Description |
---|---|
UCS_RET_SUCCESS | No error |
UCS_RET_ERR_PARAM | At least one parameter is NULL. |
UCS_RET_ERR_ALREADY_SET | The given route is already active or inactive |
UCS_RET_ERR_NOT_INITIALIZED | UNICENS is not initialized |
ucs_cfg.h
ucs_xrm_cfg.h
ucs_xrm_cfg.h
UCS_ADDR_LOCAL_DEV
macro to address the local device when specifying connection routes to or from this device.
Example