1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. CAUTION: this document is generated from source in doc/src/rtd.
4 .. To make changes edit the source and recompile the document.
5 .. Do NOT make changes directly to .rst or .md files.
7 ============================================================================================
9 ============================================================================================
15 RMR routes messages based on a combination of message type
16 and subscription ID both of which are integers. The message
17 type constants are defined in the RIC_msg_types.h header file
18 included with the RMR development package while subscription
19 IDs are generated by the subscription manager process at
20 run-time. This document does not include the constant values
21 to avoid incorrectly propagating a stale value through the
22 reference of an outdated document.
25 Non-Routable Message Types
26 --------------------------
28 These message types are not routable and a message passed to
29 an RMR function with any of these constants set will not be
39 Message type is unset or undefined. Newly allocated messages
40 have the type value set to this constant.
45 RMR Reserved Message Types
46 --------------------------
48 These message types are reserved for RMR communications (e.g.
56 * - **RMRRM_TABLE_DATA**
58 Table data from route manger. Route manager sends all route
59 mse, etc.) with this type.
61 * - **RMRRM_REQ_TABLE**
63 Request for table update. RMR will send a message with this a
64 table update from route manger.
66 * - **RMRRM_TABLE_STATE**
68 This message type conveys the state of the route table to the
69 end of a table is noticed.
74 System Support Message Types
75 ----------------------------
77 These message types are used for systems level communications
78 such as health checks, alarms and probes.
85 * - **RIC_HEALTH_CHECK_REQ**
87 When received the application is expected to return a
88 response to the current "health" of the application.
90 * - **RIC_HEALTH_CHECK_RESP**
92 Health responses are sent with a message of this type.
96 Alarm messages with this type are routed to the alarm
99 * - **RIC_ALARM_QUERY**
105 This message type causes the message to be routed to the xAPP
106 responsible redistributing metrics.
111 Unclassified Message Types
112 --------------------------
114 The following message types have not been clasified into a
122 * - **RIC_SCTP_CONNECTION_FAILURE**
126 * - **RIC_SCTP_CLEAR_ALL**
134 * - **E2_TERM_KEEP_ALIVE_REQ**
138 * - **E2_TERM_KEEP_ALIVE_RESP**
142 * - **RAN_CONNECTED**
146 * - **RAN_RESTARTED**
150 * - **RAN_RECONFIGURED**
154 * - **RIC_ENB_LOAD_INFORMATION**
158 * - **RIC_ERROR_INDICATION**
162 * - **RIC_SN_STATUS_TRANSFER**
166 * - **RIC_UE_CONTEXT_RELEASE**
170 * - **RIC_X2_SETUP_REQ**
174 * - **RIC_X2_SETUP_RESP**
178 * - **RIC_X2_SETUP_FAILURE**
186 * - **RIC_X2_RESET_RESP**
190 * - **RIC_ENB_CONF_UPDATE**
194 * - **RIC_ENB_CONF_UPDATE_ACK**
198 * - **RIC_ENB_CONF_UPDATE_FAILURE**
202 * - **RIC_RES_STATUS_REQ**
206 * - **RIC_RES_STATUS_RESP**
210 * - **RIC_RES_STATUS_FAILURE**
214 * - **RIC_RESOURCE_STATUS_UPDATE**
218 * - **RIC_SGNB_ADDITION_REQ**
222 * - **RIC_SGNB_ADDITION_ACK**
226 * - **RIC_SGNB_ADDITION_REJECT**
230 * - **RIC_SGNB_RECONF_COMPLETE**
234 * - **RIC_SGNB_MOD_REQUEST**
238 * - **RIC_SGNB_MOD_REQUEST_ACK**
242 * - **RIC_SGNB_MOD_REQUEST_REJ**
246 * - **RIC_SGNB_MOD_REQUIRED**
250 * - **RIC_SGNB_MOD_CONFIRM**
254 * - **RIC_SGNB_MOD_REFUSE**
258 * - **RIC_SGNB_RELEASE_REQUEST**
262 * - **RIC_SGNB_RELEASE_REQUEST_ACK**
266 * - **RIC_SGNB_RELEASE_REQUIRED**
270 * - **RIC_SGNB_RELEASE_CONFIRM**
274 * - **RIC_RRC_TRANSFER**
278 * - **RIC_ENDC_X2_SETUP_REQ**
282 * - **RIC_ENDC_X2_SETUP_RESP**
286 * - **RIC_ENDC_X2_SETUP_FAILURE**
290 * - **RIC_ENDC_CONF_UPDATE**
294 * - **RIC_ENDC_CONF_UPDATE_ACK**
298 * - **RIC_ENDC_CONF_UPDATE_FAILURE**
302 * - **RIC_SECONDARY_RAT_DATA_USAGE_REPORT**
306 * - **RIC_GNB_STATUS_INDICATION**
310 * - **RIC_E2_SETUP_REQ**
314 * - **RIC_E2_SETUP_RESP**
318 * - **RIC_E2_SETUP_FAILURE**
322 * - **RIC_E2_RESET_REQ**
326 * - **RIC_E2_RESET_RESP**
330 * - **RIC_E2_RAN_ERROR_INDICATION**
334 * - **RIC_E2_RIC_ERROR_INDICATION**
338 * - **RAN_E2_RESET_REQ**
342 * - **RAN_E2_RESET_RESP**
354 * - **RIC_SUB_FAILURE**
358 * - **RIC_SUB_DEL_REQ**
362 * - **RIC_SUB_DEL_RESP**
366 * - **RIC_SUB_DEL_FAILURE**
370 * - **RIC_SERVICE_UPDATE**
374 * - **RIC_SERVICE_UPDATE_ACK**
378 * - **RIC_SERVICE_UPDATE_FAILURE**
382 * - **RIC_CONTROL_REQ**
386 * - **RIC_CONTROL_ACK**
390 * - **RIC_CONTROL_FAILURE**
394 * - **RIC_INDICATION**
398 * - **RIC_SERVICE_QUERY**
402 * - **DC_ADM_INT_CONTROL**
406 * - **DC_ADM_INT_CONTROL_ACK**
410 * - **DC_ADM_GET_POLICY**
414 * - **DC_ADM_GET_POLICY_ACK**
418 * - **A1_POLICY_REQ**
422 * - **A1_POLICY_RESP**
426 * - **A1_POLICY_QUERY**
434 * - **TS_QOE_PRED_REQ**
438 * - **TS_QOE_PREDICTION**
442 * - **TS_ANOMALY_UPDATE**
446 * - **TS_ANOMALY_ACK**
454 * - **DCAPTERM_RTPM_RMR_MSGTYPE**
458 * - **DCAPTERM_GEO_RMR_MSGTYPE**
466 * - **RIC_X2_RESPONSE**
470 * - **RIC_X2_RESOURCE_STATUS_REQUEST**
474 * - **RIC_X2_RESOURCE_STATUS_RESPONSE**
478 * - **RIC_X2_LOAD_INFORMATION**
482 * - **RIC_E2_TERMINATION_HC_REQUEST**
486 * - **RIC_E2_TERMINATION_HC_RESPONSE**
490 * - **RIC_E2_MANAGER_HC_REQUEST**
494 * - **RIC_E2_MANAGER_HC_RESPONSE**
498 * - **RIC_CONTROL_XAPP_CONFIG_REQUEST**
502 * - **RIC_CONTROL_XAPP_CONFIG_RESPONSE**
Code Review / ric-plt / lib / rmr.git / blob