X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=src%2Frmr%2Fcommon%2Finclude%2Frmr.h;h=5802cc63bcb559a2c949bceb87486b4587da1c5e;hb=refs%2Fchanges%2F66%2F666%2F2;hp=a824a2a26de167f95d917252d956e7a66b8035ec;hpb=54098f653ce4977668cc3ea9c0ce546a08ef577c;p=ric-plt%2Flib%2Frmr.git

diff --git a/src/rmr/common/include/rmr.h b/src/rmr/common/include/rmr.h
index a824a2a..5802cc6 100644
--- a/src/rmr/common/include/rmr.h
+++ b/src/rmr/common/include/rmr.h
@@ -78,6 +78,14 @@ extern "C" {
 
 	(All fields are exposed such that if a wrapper needs to dup the storage as it passes
 	into or out of their environment they dup it all, not just what we choose to expose.)
+
+	NOTE:
+	State is the RMR state of processing on the message. The transport state (tp_state)
+	will be set to mirror the value of errno for wrappers unable to access errno directly,
+	but will only be set if state is not RMR_OK. Even then, the value may be suspect as
+	the underlying transport mechanism may not set errno. It is strongly recommended that
+	user applications use tp_state only for dianostic purposes to convey additional information
+	in a log message.
 */
 typedef struct {
 	int	state;					// state of processing
@@ -86,6 +94,7 @@ typedef struct {
 	unsigned char* payload;		// transported data
 	unsigned char* xaction;		// pointer to fixed length transaction id bytes
 	int sub_id;					// subscription id
+	int		tp_state;			// transport state (errno) valid only if state != RMR_OK, and even then may not be valid
 
 								// these things are off limits to the user application
 	void*	tp_buf;				// underlying transport allocated pointer (e.g. nng message)