Ucs_Return_t Ucs_Rm_Start | ( | Ucs_Inst_t * | self, |
Ucs_Rm_Route_t * | routes_list, | ||
uint16_t | list_size | ||
) |
Initializes the routing process with the given routes list information and starts the process to handle the route(s).
When calling this function the routing management will be initialized to the given values and the process to handle the routes list started. The internal_infos structure of route, endpoint and node objects should be therefore zero-initialized by customer application (See the example below). The result of each route is reported via the user callback function report_fptr in Ucs_InitData_t (if It has been set by user).
self | The UNICENS instance pointer. |
routes_list | List of routes to be handled. |
list_size | Size of the given routes list. |
Value | Description |
---|---|
UCS_RET_SUCCESS | No error |
UCS_RET_ERR_PARAM | At least one parameter is NULL |
UCS_RET_ERR_API_LOCKED | API is currently locked |
UCS_RET_ERR_NOT_INITIALIZED | UNICENS is not initialized |
0xFF
and the minimum time between the retries is 50ms
.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