New upstream version 8.1.0

client_module/source/common/net/message/control/GenericResponseMsg.h

@@ -0,0 +1,65 @@
+#ifndef GENERICRESPONSEMSG_H_
+#define GENERICRESPONSEMSG_H_
+
+#include <common/net/message/SimpleIntStringMsg.h>
+
+
+/**
+ * Note: Remember to keep this in sync with userspace common lib.
+ */
+enum GenericRespMsgCode
+{
+   GenericRespMsgCode_TRYAGAIN          =  0, /* requestor shall try again in a few seconds */
+   GenericRespMsgCode_INDIRECTCOMMERR   =  1, /* indirect communication error and requestor should
+      try again (e.g. msg forwarding to other server failed) */
+   GenericRespMsgCode_NEWSEQNOBASE = 2, /* client has restarted its seq# sequence. server provides
+      the new starting seq#. */
+};
+typedef enum GenericRespMsgCode GenericRespMsgCode;
+
+
+struct GenericResponseMsg;
+typedef struct GenericResponseMsg GenericResponseMsg;
+
+
+static inline void GenericResponseMsg_init(GenericResponseMsg* this);
+
+// getters & setters
+static inline GenericRespMsgCode GenericResponseMsg_getControlCode(GenericResponseMsg* this);
+static inline const char* GenericResponseMsg_getLogStr(GenericResponseMsg* this);
+
+
+/**
+ * A generic response that can be sent as a reply to any message. This special control message will
+ * be handled internally by the requestors MessageTk::requestResponse...() method.
+ *
+ * This is intended to submit internal information (like asking for a communication retry) to the
+ * requestors MessageTk through the control code. So the MessageTk caller on the requestor side
+ * will never actually see this GenericResponseMsg.
+ *
+ * The message string is intended to provide additional human-readable information like why this
+ * control code was submitted instead of the actually expected response msg.
+ */
+struct GenericResponseMsg
+{
+   SimpleIntStringMsg simpleIntStringMsg;
+};
+
+
+void GenericResponseMsg_init(GenericResponseMsg* this)
+{
+   SimpleIntStringMsg_init( (SimpleIntStringMsg*)this, NETMSGTYPE_GenericResponse);
+}
+
+GenericRespMsgCode GenericResponseMsg_getControlCode(GenericResponseMsg* this)
+{
+   return (GenericRespMsgCode)SimpleIntStringMsg_getIntValue( (SimpleIntStringMsg*)this);
+}
+
+const char* GenericResponseMsg_getLogStr(GenericResponseMsg* this)
+{
+   return SimpleIntStringMsg_getStrValue( (SimpleIntStringMsg*)this);
+}
+
+
+#endif /* GENERICRESPONSEMSG_H_ */