+/*
+ Header file defining message types for various RMR messages.
+ This file is an exception: please expand tabs.
+*/
+
+/*
+ This file is scraped and documentation is produced from the comments. Block
+ comments which have have a plus sign immediately following the asterisk
+ (e.g. /*+) will be interpereted as a header, followed by a paragraph
+ of text. Blank lines are preserved, and consecutive text lines are combined
+ such that the convenient method of starting a new sentance on a new line
+ is enabled.
+
+ Line comments which have a trailing plus sign (e.g. //+) are used to document
+ the individual constant. These _must_ begin on the same line as the constant
+ and may "splill" to following lines if needed.
+
+ Occasionally constants are deprecated and should not be used. Tagging a comment
+ with //- will cause the constant to be included in the document and flagged as
+ deprecated while //-- will cause the constant to be ignored when generating the
+ document.
+
+ All recognised comment symbols must have at least one trailing space, or be
+ the last token on the line (//+boo wont be recognised).
+
+ The layout of this file is "two column" to allow the eyes to easy read down
+ though constant names and values without being interrupted by the documentation
+ (commetns) which are placed to the right. Only major section descriptions
+ should break the "flow."
+
+ Other requests:
+ - Please keep additions in numerical order
+ - Please vet the file before commiting changes to ensure that it compiles
+ and that there are no dupicates.
+ - Please try to avoid excessivly long constant names e.g. RIC_SECONDARY_RAT_DATA_USAGE_REPORT
+*/
+
+/*+
+ Overview
+ RMR routes messages based on a combination of message type and subscription ID
+ both of which are integers.
+ The message type constants are defined in the RIC_msg_types.h header file included with the RMR
+ development package while subscription IDs are generated by the subscription manager
+ process at run-time.
+ This document does not include the constant values to avoid incorrectly propagating
+ a stale value through the reference of an outdated document.
+*/
+
+/*+
+ Non-Routable Message Types
+ These message types are not routable and a message passed to an RMR function with any of
+ these constants set will not be sent.
+*/
+
+#define RIC_UNDEFINED -1 //+ Message type is unset or undefined. Newly allocated messages
+ //+ by rmr_alloc_msg() will have the type value set to this constant.
+
+/*+
+ RMR Reserved Message Types
+ These message types are reserved for RMR communications (e.g. with Route Manager).
+*/
+// All message types 0 - 99 are reserved for RMR.
+
+#define RMRRM_TABLE_DATA 20 //+ Table data from route manger. Route manager sends all route
+ //+ table records (rte, mse, etc.) with this type.
+#define RMRRM_REQ_TABLE 21 //+ Request for table update. RMR will send a message with this
+ //+ type when requesting a table update from route manger.
+#define RMRRM_TABLE_STATE 22 //+ This message type conveys the state of the route table to
+ //+ route manager after the end of a table is noticed.
+
+
+/*+
+ System Support Message Types
+ These message types are used for systems level communications such
+ as health checks, alarms and probes.
+*/
+// Values for system constants are 100-299
+
+#define RIC_HEALTH_CHECK_REQ 100 //+ When received the application is expected to return a response to
+ //+ the sender indicating the current "health" of the application.
+#define RIC_HEALTH_CHECK_RESP 101 //+ Health responses are sent with a message of this type.