Routing Management

Provides service functions to handle connection routes. More...

Topics
	Extended Resources Management
	Provides data type to manage MOST data resources.
	Referred Types
	Referred types used by Routing service functions.

Data Structures
struct	Ucs_Rm_InitData_t
	The initialization structure of the Routing Management. More...

Callback Functions
typedef void(*	Ucs_Rm_ReportCb_t )(Ucs_Rm_Route_t *route_ptr, Ucs_Rm_RouteInfos_t route_infos, void *user_ptr)
	Function signature used for the results and reports of the Routing Manager.
typedef void(*	Ucs_Rm_XrmResDebugCb_t )(Ucs_Xrm_ResourceType_t resource_type, Ucs_Xrm_ResObject_t *resource_ptr, Ucs_Xrm_ResourceInfos_t resource_infos, Ucs_Rm_EndPoint_t *endpoint_inst_ptr, void *user_ptr)
	Function signature used for monitoring the XRM resources.

Functions
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).
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.
Ucs_Return_t	Ucs_Rm_SetNodeAvailable (Ucs_Inst_t *self, Ucs_Rm_Node_t *node_ptr, bool available)
	Sets the availability attribute (available or not available) of the given node and triggers the routing process to handle attached route(s).
bool	Ucs_Rm_GetNodeAvailable (Ucs_Inst_t *self, Ucs_Rm_Node_t *node_ptr)
	Retrieves the "available" flag information of the given node.
Ucs_Return_t	Ucs_Rm_GetAttachedRoutes (Ucs_Inst_t *self, Ucs_Rm_EndPoint_t *ep_inst, Ucs_Rm_Route_t *ls_found_routes[], uint16_t ls_size)
	Retrieves the reference(s) of the route(s) currently attached to the given endpoint and stores It into the (external) table provided by user application.
uint16_t	Ucs_Rm_GetConnectionLabel (Ucs_Inst_t *self, Ucs_Rm_Route_t *route_ptr)
	Retrieves the ConnectionLabel of the given route.

Detailed Description

Provides service functions to handle connection routes.