Improve event subscription (#423)

This should improve events reliability when subscribing to events with FQDN containing localhost or network aliases or when there are multiple network interfaces (#315). The situation is especially improved when using an AttributeProxy for the event subscription.
Limitation: in case DeviceProxy is used for event subscription, client might get an incorrect event name value in the event data (containing a TANGO_HOST  hostname slightly different than the one used during the FQDN subscription or in the env. variable) in the event callback if short domain name is used in TANGO_HOST environment variable e.g. hzgc103k -> hzgc103.desy.de

Author: Ingvord

CMakeLists.txt

@@ -4,8 +4,8 @@ include(CTest)
 enable_testing()
 #need to define the version of the library
 set(MAJOR_VERSION "9")
-set(MINOR_VERSION "2")
-set(PATCH_VERSION "8")
+set(MINOR_VERSION "3")
+set(PATCH_VERSION "0")
 
 if(WIN32)
     include(configure/cmake_win_defs.cmake)
@@ -25,6 +25,7 @@ include_directories(cppapi/server)
 include_directories(cppapi/server/idl)
 include_directories(log4tango/include)
 #required for generated config.h
+include_directories(${CMAKE_CURRENT_BINARY_DIR}/cppapi/server)
 include_directories(${CMAKE_CURRENT_BINARY_DIR}/log4tango/include)
 
 

RELEASE_NOTES

@@ -1,5 +1,13 @@
+9.3.0
+=====
+
+1. Fix FQDN events.
+   Limitations:
+     - in case DeviceProxy is used for event subscription client will get incorrect value in the event callback if short domain name is used in env.TANGO_HOST e.g. hzgc103k -> hzgc103.desy.de
+
 9.2.8
 =====
+
 1. Cmake release targets #438 - Fix appveyor build. 
    Install include files in <install_prefix>/include/tango directory instead of 
    <install_prefix>/include.

cpp_test_suite/environment/setup.sh

@@ -9,6 +9,7 @@ docker run --name mysql_db \
 
 #run tango-cs docker
 CONTAINER=$(docker run --name tango_cs \
+    -p 10000:10000 \
     -e TANGO_HOST=127.0.0.1:10000 \
     -e MYSQL_HOST=mysql_db:3306 \
     -e MYSQL_USER=tango \

cpp_test_suite/new_tests/cxx_cmd_query.cpp

@@ -520,29 +520,31 @@ class CmdQueryTestSuite: public CxxTest::TestSuite
 	void test_command_list_query_ZMQEventSubscriptionChange(void)
 	{
 //		CommandInfo cmd_inf = dserver->command_query("ZmqEventSubscriptionChange");
-		CommandInfo cmd_inf = cmd_inf_list[31];
-		TS_ASSERT_EQUALS(cmd_inf.cmd_name,"ZmqEventSubscriptionChange");
-		TS_ASSERT_EQUALS(cmd_inf.in_type,Tango::DEVVAR_STRINGARRAY);
-		TS_ASSERT_EQUALS(cmd_inf.out_type,Tango::DEVVAR_LONGSTRINGARRAY);
-		TS_ASSERT_EQUALS(cmd_inf.in_type_desc,"Event consumer wants to subscribe to.\n"
-		                                      "device name, attribute/pipe name, action (\"subscribe\"), event name, <Tango client IDL version>\"\n"
-		                                      "event name can take the following values:\n"
-		                                      "    \"change\",\n"
-		                                      "    \"quality\",\n"
-		                                      "    \"periodic\",\n"
-		                                      "    \"archive\",\n"
-		                                      "    \"user_event\",\n"
-		                                      "    \"attr_conf\",\n"
-		                                      "    \"data_ready\",\n"
-		                                      "    \"intr_change\",\n"
-		                                      "    \"pipe\"\n"
-		                                      "\"info\" can also be used as single parameter to retrieve information about the heartbeat and event pub endpoints.");
-		TS_ASSERT_EQUALS(cmd_inf.out_type_desc,"Str[0] = Heartbeat pub endpoint - Str[1] = Event pub endpoint\n"
-		                                       "...\n"
-		                                       "Str[n] = Alternate Heartbeat pub endpoint - Str[n+1] = Alternate Event pub endpoint\n"
-		                                       "Lg[0] = Tango lib release - Lg[1] = Device IDL release\n"
-		                                       "Lg[2] = Subscriber HWM - Lg[3] = Multicast rate\n"
-		                                       "Lg[4] = Multicast IVL - Lg[5] = ZMQ release");
+        CommandInfo cmd_inf = cmd_inf_list[31];
+        TS_ASSERT_EQUALS(cmd_inf.cmd_name, "ZmqEventSubscriptionChange");
+        TS_ASSERT_EQUALS(cmd_inf.in_type, Tango::DEVVAR_STRINGARRAY);
+        TS_ASSERT_EQUALS(cmd_inf.out_type, Tango::DEVVAR_LONGSTRINGARRAY);
+        TS_ASSERT_EQUALS(cmd_inf.in_type_desc, "Event consumer wants to subscribe to.\n"
+            "device name, attribute/pipe name, action (\"subscribe\"), event name, <Tango client IDL version>\"\n"
+            "event name can take the following values:\n"
+            "    \"change\",\n"
+            "    \"quality\",\n"
+            "    \"periodic\",\n"
+            "    \"archive\",\n"
+            "    \"user_event\",\n"
+            "    \"attr_conf\",\n"
+            "    \"data_ready\",\n"
+            "    \"intr_change\",\n"
+            "    \"pipe\"\n"
+            "\"info\" can also be used as single parameter to retrieve information about the heartbeat and event pub endpoints.");
+        TS_ASSERT_EQUALS(cmd_inf.out_type_desc, "Str[0] = Heartbeat pub endpoint - Str[1] = Event pub endpoint\n"
+            "...\n"
+            "Str[n] = Alternate Heartbeat pub endpoint - Str[n+1] = Alternate Event pub endpoint\n"
+            "Str[n+1] = event name used by this server as zmq topic to send events\n"
+            "Str[n+2] = channel name used by this server to send heartbeat events\n"
+            "Lg[0] = Tango lib release - Lg[1] = Device IDL release\n"
+            "Lg[2] = Subscriber HWM - Lg[3] = Multicast rate\n"
+            "Lg[4] = Multicast IVL - Lg[5] = ZMQ release");
 	}
 
 };

cppapi/client/AttributeProxy.h

@@ -79,7 +79,8 @@ private :
     class AttributeProxyExt
     {
     public:
-        AttributeProxyExt() {};
+        string user_defined_name;
+        AttributeProxyExt(const string& name):user_defined_name(name) {};
     };
 
 #ifdef HAS_UNIQUE_PTR
@@ -89,6 +90,7 @@ private :
 #endif
 
 public :
+    string get_user_defined_name() const { return ext->user_defined_name; }
 ///@name Constructors
 //@{
 /**

cppapi/client/attr_proxy.cpp

@@ -57,12 +57,12 @@ namespace Tango
 //
 //-----------------------------------------------------------------------------
 
-AttributeProxy::AttributeProxy (string &name):dev_proxy(NULL),ext(Tango_nullptr)
+AttributeProxy::AttributeProxy (string &name):dev_proxy(NULL),ext(new AttributeProxyExt(name))
 {
 	real_constructor(name);
 }
 
-AttributeProxy::AttributeProxy (const char *na):dev_proxy(NULL),ext(Tango_nullptr)
+AttributeProxy::AttributeProxy (const char *na):dev_proxy(NULL),ext(new AttributeProxyExt(na))
 {
 	string name(na);
 	real_constructor(name);
@@ -294,12 +294,12 @@ AttributeProxy::AttributeProxy(const AttributeProxy &prev):ext(Tango_nullptr)
 #ifdef HAS_UNIQUE_PTR
     if (prev.ext.get() != NULL)
     {
-        ext.reset(new AttributeProxyExt);
+        ext.reset(new AttributeProxyExt(prev.get_user_defined_name()));
     }
 #else
 	if (prev.ext != NULL)
 	{
-		ext = new AttributeProxyExt();
+		ext = new AttributeProxyExt(prev.get_user_defined_name());
 		*ext = *(prev.ext);
 	}
 	else
@@ -370,13 +370,13 @@ AttributeProxy &AttributeProxy::operator=(const AttributeProxy &rval)
 
 #ifdef HAS_UNIQUE_PTR
         if (rval.ext.get() != NULL)
-            ext.reset(new AttributeProxyExt);
+            ext.reset(new AttributeProxyExt(rval.get_user_defined_name()));
         else
             ext.reset();
 #else
         if (rval.ext != NULL)
         {
-            ext = new AttributeProxyExt();
+            ext = new AttributeProxyExt(rval.get_user_defined_name());
             *ext = *(rval.ext);
         }
         else
@@ -1358,7 +1358,11 @@ int AttributeProxy::subscribe_event (EventType event, CallBack *callback,
 	int ret;
 	try
 	{
-        ret = api_ptr->get_zmq_event_consumer()->subscribe_event(dev_proxy,attr_name, event, callback, filters, stateless);
+		//we use filters here to pass user defined attribute name to later use it in event callback
+		// see https://github.com/tango-controls/cppTango/pull/423
+        vector<string> non_const_filters;
+        non_const_filters.push_back(get_user_defined_name());
+        ret = api_ptr->get_zmq_event_consumer()->subscribe_event(dev_proxy,attr_name, event, callback, non_const_filters, stateless);
 	}
 	catch (DevFailed &e)
 	{