Attempt to fix #455 and #456

Attempt to fix reconnection issues in Tango 9.3.0 and 9.3.1 when a client
subscribes to several events (#455)
Attempt to fix compatibility issues with Tango <= 8 device servers.
This commit is based on @bourtemb's work on PR #465 and @Ingvord work done on
PR #467 and PR #468.
This solves merge conflicts between PR #467 and #468.
Fix event field in EventData structure passed to user's callback (broken in
Tango 9.3.0 and 9.3.1)
Fix 1 unused variable compilation warning
Add the possibility to compile the code on old compilers (issue with override keyword)
Fix attribute name in EventData structure passed to user's callback for
Attribute Config events

Author: bourtemb

cppapi/client/event.cpp

@@ -1372,7 +1372,7 @@ int EventConsumer::connect_event(DeviceProxy *device,
 				   int event_id)
 {
 	int ret_event_id = event_id;
-	device_name = device->dev_name();
+	device_name = device->dev_name();//TODO convert to local
 	cout3 << "Tango::EventConsumer::connect_event(" << device_name << "," << obj_name <<"," << event << ")\n";
 
 	bool inter_event = false;
@@ -1580,7 +1580,7 @@ int EventConsumer::connect_event(DeviceProxy *device,
 		local_callback_key.insert(pos + 1,EVENT_COMPAT_IDL5);
 	}
 
-	initialize_received_from_admin(dvlsa, local_callback_key, adm_name, device->get_from_env_var());
+	ReceivedFromAdmin received_from_admin = initialize_received_from_admin(dvlsa, local_callback_key, adm_name, device->get_from_env_var());
 
 	//
 	// Do we already have this event in the callback map? If yes, simply add this new callback to the event callback list
@@ -1696,6 +1696,7 @@ int EventConsumer::connect_event(DeviceProxy *device,
     EventCallBackStruct new_event_callback;
     EventSubscribeStruct new_ess;
 
+    new_event_callback.received_from_admin = received_from_admin;
     new_event_callback.device = device;
     new_event_callback.obj_name = obj_name_lower;
     new_event_callback.event_name = event_name;
@@ -1832,59 +1833,6 @@ string EventConsumer::get_client_attribute_name(const string &local_callback_key
 	return local_callback_key.substr(0, pos);
 }
 
-void Tango::EventConsumer::initialize_received_from_admin(const Tango::DevVarLongStringArray *dvlsa,
-                                                          const string &local_callback_key,
-                                                          const string &adm_name,
-                                                          bool device_from_env_var)
-{
- 	if(dvlsa->lvalue.length() == 0)
-	{
-		EventSystemExcept::throw_exception(API_NotSupported,
-                                           "Server did not send its tango lib version. The server is possibly too old. The event system is not initialized!",
-                                           "EventConsumer::initialize_received_from_admin()");
-	}	
-	
-	long server_tango_lib_ver = dvlsa->lvalue[0];
-
-    //event name is used for zmq topics filtering
-    //channel name is used for heartbeat events
-	if (server_tango_lib_ver >= 930)
-	{
-		received_from_admin.event_name = (dvlsa->svalue[dvlsa->svalue.length() - 2]);
-                received_from_admin.channel_name = (dvlsa->svalue[dvlsa->svalue.length() - 1]);
-	}
-	else
-	{
-		received_from_admin.event_name = local_callback_key;
-
-		string adm_name_lower(adm_name);
-		if (device_from_env_var)
-		{
-			adm_name_lower.insert(0, env_var_fqdn_prefix[0]);
-		}
-
-		transform(adm_name_lower.begin(), adm_name_lower.end(), adm_name_lower.begin(), ::tolower);
-		received_from_admin.channel_name = adm_name_lower;
-	}
-
-        if (received_from_admin.event_name.empty())
-        {
-                EventSystemExcept::throw_exception(API_NotSupported,
-                                           "Server did not send the event name. The server is possibly too old. The event system is not initialized!",
-                                           "EventConsumer::initialize_received_from_admin()");
-        
-        }
-
-	cout4 << "received_from_admin.event_name = " << received_from_admin.event_name << endl;
-        if (received_from_admin.channel_name.empty())
-        {
-                EventSystemExcept::throw_exception(API_NotSupported,
-                                           "Server did not send the channel name. The server is possibly too old. The event system is not initialized!",
-                                           "EventConsumer::initialize_received_from_admin()");        
-        }
-	cout4 << "received_from_admin.channel_name = " << received_from_admin.channel_name << endl;
-}
-
 //+-------------------------------------------------------------------------------------------------------------------
 //
 // method :
@@ -3237,7 +3185,10 @@ void EventConsumer::get_fire_sync_event(DeviceProxy *device,CallBack *callback,E
 			err = e.errors;
 		}
 
-		string local_event_name = cb.get_client_attribute_name();
+		string local_event_name = event_name;
+		pos = local_event_name.find(EVENT_COMPAT);
+		if (pos != string::npos)
+			local_event_name.erase(0,EVENT_COMPAT_IDL5_SIZE);
 		string local_domain_name = cb.get_client_attribute_name();
 
 		if (cb.fwd_att == true)
@@ -3286,7 +3237,7 @@ void EventConsumer::get_fire_sync_event(DeviceProxy *device,CallBack *callback,E
 	{
 		DevErrorList err;
 		err.length(0);
-		string domain_name = device_name + "/" + obj_name_lower;
+		string local_domain_name = cb.get_client_attribute_name();
 		AttributeInfoEx *aie = NULL;
 
 		string local_event_name = event_name;
@@ -3305,7 +3256,7 @@ void EventConsumer::get_fire_sync_event(DeviceProxy *device,CallBack *callback,E
 		}
 
 		FwdAttrConfEventData *event_data = new FwdAttrConfEventData(device,
-						      domain_name,
+						      local_domain_name,
 						      local_event_name,
 						      aie,
 						      err);

cppapi/client/eventconsumer.h

@@ -329,6 +329,12 @@ typedef struct event_not_connected
 
 //------------------------ Event Callback related info --------------------------------------
 
+struct ReceivedFromAdmin
+{
+    string event_name;
+    string channel_name;
+};
+
 typedef struct event_subscribe
 {
 	EventQueue						*ev_queue;
@@ -364,6 +370,7 @@ typedef struct event_callback: public EventCallBackBase, public EventCallBackZmq
 	CosNotifyFilter::FilterID filter_id;
 	bool filter_ok;
 	string client_attribute_name;
+	ReceivedFromAdmin received_from_admin;
 	string get_client_attribute_name()
 	{
 		return client_attribute_name;
@@ -496,15 +503,12 @@ protected :
     virtual void set_channel_type(EventChannelStruct &) = 0;
     virtual void zmq_specific(DeviceData &,string &,DeviceProxy *,const string &) = 0;
 
-    void initialize_received_from_admin(const Tango::DevVarLongStringArray *pArray,
-                                            const string &local_callback_key,
-                                            const string &adm_name,
-                                            bool device_from_env_var);
-    struct
-    {
-        string event_name;
-        string channel_name;
-    } received_from_admin;
+   
+    
+    virtual ReceivedFromAdmin initialize_received_from_admin(const Tango::DevVarLongStringArray *pArray,
+                                                             const string &local_callback_key,
+                                                             const string &adm_name,
+                                                             bool device_from_env_var)=0;
 };
 
 /********************************************************************************
@@ -539,6 +543,17 @@ protected :
 
     virtual void set_channel_type(EventChannelStruct &ecs) {ecs.channel_type = NOTIFD;}
 	virtual void zmq_specific(DeviceData &,string &,DeviceProxy *,const string &) {}
+#ifdef HAS_OVERRIDE
+	ReceivedFromAdmin initialize_received_from_admin(const Tango::DevVarLongStringArray *pArray,
+	                                                 const string &local_callback_key,
+	                                                 const string &adm_name,
+	                                                 bool device_from_env_var) override;
+#else
+	virtual ReceivedFromAdmin initialize_received_from_admin(const Tango::DevVarLongStringArray *pArray,
+	                                                         const string &local_callback_key,
+	                                                         const string &adm_name,
+	                                                         bool device_from_env_var);
+#endif
 
 private :
 
@@ -598,6 +613,18 @@ protected :
     virtual void set_channel_type(EventChannelStruct &ecs) {ecs.channel_type = ZMQ;}
 	virtual void zmq_specific(DeviceData &,string &,DeviceProxy *,const string &);
 
+#ifdef HAS_OVERRIDE
+	ReceivedFromAdmin initialize_received_from_admin(const Tango::DevVarLongStringArray *pArray,
+	                                                 const string &local_callback_key,
+	                                                 const string &adm_name,
+	                                                 bool device_from_env_var) override;
+#else
+	virtual ReceivedFromAdmin initialize_received_from_admin(const Tango::DevVarLongStringArray *pArray,
+	                                                         const string &local_callback_key,
+	                                                         const string &adm_name,
+	                                                         bool device_from_env_var);
+#endif
+
 private :
 	TANGO_IMP static ZmqEventConsumer       *_instance;
 	zmq::context_t                          zmq_context;            // ZMQ context

cppapi/client/notifdeventconsumer.cpp

@@ -1139,5 +1139,26 @@ void NotifdEventConsumer::push_structured_event(const CosNotification::Structure
 	}
 }
 
+ReceivedFromAdmin NotifdEventConsumer::initialize_received_from_admin(TANGO_UNUSED(const Tango::DevVarLongStringArray *dvlsa), 
+                                                                      const string &local_callback_key,
+                                                                      const string &adm_name,
+                                                                      bool device_from_env_var)
+{
+	ReceivedFromAdmin result;
+	result.event_name = local_callback_key;
+
+	string full_adm_name(adm_name);
+	if (device_from_env_var)
+	{
+		full_adm_name.insert(0, env_var_fqdn_prefix[0]);
+	}
+
+	result.channel_name = full_adm_name;
+
+	cout4 << "received_from_admin.event_name = " << result.event_name << endl;
+	cout4 << "received_from_admin.channel_name = " << result.channel_name << endl;
+	return result;
+}
+
 } /* End of Tango namespace */
 

cppapi/client/zmqeventconsumer.cpp

@@ -1658,41 +1658,11 @@ void ZmqEventConsumer::disconnect_event(string &event_name,string &endpoint)
 //
 //--------------------------------------------------------------------------------------------------------------------
 
-void ZmqEventConsumer::connect_event_system(string &device_name,string &obj_name,string &event_name,TANGO_UNUSED(const vector<string> &filters),
-                                            TANGO_UNUSED(EvChanIte &eve_it),TANGO_UNUSED(EventCallBackStruct &new_event_callback),
+void ZmqEventConsumer::connect_event_system(TANGO_UNUSED(string &device_name),TANGO_UNUSED(string &obj_name),
+                                            TANGO_UNUSED(string &event_name),TANGO_UNUSED(const vector<string> &filters),
+                                            TANGO_UNUSED(EvChanIte &eve_it),EventCallBackStruct &new_event_callback,
                                             DeviceData &dd,size_t valid_end)
 {
-//
-// Build full event name
-// Don't forget case of device in a DS using file as database
-//
-
-    string full_event_name;
-    string::size_type pos;
-
-    bool inter_event = false;
-    if (event_name == EventName[INTERFACE_CHANGE_EVENT])
-		inter_event = true;
-
-    if ((pos = device_name.find(MODIFIER_DBASE_NO)) != string::npos)
-    {
-        full_event_name = device_name;
-        if (inter_event == false)
-		{
-			string tmp = '/' + obj_name;
-			full_event_name.insert(pos,tmp);
-		}
-        full_event_name = full_event_name + '.' + event_name;
-    }
-    else
-	{
-		if (inter_event == true)
-			full_event_name = device_name + '.' + event_name;
-		else
-			full_event_name = device_name + '/' + obj_name + '.' + event_name;
-	}
-
-
 //
 // Extract server command result
 //
@@ -1764,8 +1734,8 @@ void ZmqEventConsumer::connect_event_system(string &device_name,string &obj_name
         ::strcpy(&(buffer[length]),endpoint.c_str());
         length = length + endpoint.size() + 1;
 
-        ::strcpy(&(buffer[length]), received_from_admin.event_name.c_str());
-        length = length + received_from_admin.event_name.size() + 1;
+        ::strcpy(&(buffer[length]), new_event_callback.received_from_admin.event_name.c_str());
+        length = length + new_event_callback.received_from_admin.event_name.size() + 1;
 
         DevLong user_hwm = au->get_user_sub_hwm();
         if (user_hwm != -1)
@@ -3513,6 +3483,69 @@ void ZmqEventConsumer::set_socket_hwm(int hwm)
     }
 }
 
+ReceivedFromAdmin ZmqEventConsumer::initialize_received_from_admin(const Tango::DevVarLongStringArray *dvlsa,
+                                                                   const string &local_callback_key,
+                                                                   const string &adm_name,
+                                                                   bool device_from_env_var)
+{
+    ReceivedFromAdmin result;
+    if (dvlsa->lvalue.length() == 0)
+    {
+        EventSystemExcept::throw_exception(API_NotSupported,
+                                           "Server did not send its tango lib version. The server is possibly too old. The event system is not initialized!",
+                                           "ZmqEventConsumer::initialize_received_from_admin()");
+    }
+
+    long server_tango_lib_ver = dvlsa->lvalue[0];
+
+    //event name is used for zmq topics filtering
+    //channel name is used for heartbeat events
+    if (server_tango_lib_ver >= 930)
+    {
+        result.event_name = (dvlsa->svalue[dvlsa->svalue.length() - 2]);
+        result.channel_name = (dvlsa->svalue[dvlsa->svalue.length() - 1]);
+    }
+    else
+    {
+        result.event_name = local_callback_key;
+
+        if(server_tango_lib_ver >= 810)
+        {
+            string adm_name_lower(adm_name);
+            if (device_from_env_var)
+            {
+                adm_name_lower.insert(0, env_var_fqdn_prefix[0]);
+            }
+            transform(adm_name_lower.begin(), adm_name_lower.end(), adm_name_lower.begin(), ::tolower);
+            result.channel_name = adm_name_lower;
+        }
+        else
+        {
+            // For event coming from server still using Tango 8.0.x or below, do not lowercase
+            // the adm_name in the channel name
+            result.channel_name = adm_name;
+        }
+    }
+
+    if (result.event_name.empty())
+    {
+        EventSystemExcept::throw_exception(API_NotSupported,
+                                           "Server did not send the event name. The server is possibly too old. The event system is not initialized!",
+                                           "ZmqEventConsumer::initialize_received_from_admin()");
+
+    }
+
+    cout4 << "received_from_admin.event_name = " << result.event_name << endl;
+    if (result.channel_name.empty())
+    {
+        EventSystemExcept::throw_exception(API_NotSupported,
+                                           "Server did not send the channel name. The server is possibly too old. The event system is not initialized!",
+                                           "ZmqEventConsumer::initialize_received_from_admin()");
+    }
+    cout4 << "received_from_admin.channel_name = " << result.channel_name << endl;
+    return result;
+}
+
 //--------------------------------------------------------------------------------------------------------------------
 //
 // method :

cppapi/server/tango_config.h

@@ -163,6 +163,9 @@
                 #define HAS_RANGE_BASE_FOR
                 #define INIT_LIST
             #endif
+            #if __GNUC_MINOR__ > 6
+                #define HAS_OVERRIDE
+            #endif
             #if __GNUC_MINOR__ > 7
                 #define HAS_UNDERLYING
                 #define HAS_ATTRIBUTE_SPECIFIERS
@@ -229,6 +232,7 @@
         #define HAS_UNDERLYING
         #define HAS_VARIADIC_TEMPLATE
         #define HAS_MAP_AT
+        #define HAS_OVERRIDE
     #endif
     #ifdef WIN32_VC14
         #define HAS_UNIQUE_PTR
@@ -241,6 +245,7 @@
         #define HAS_VARIADIC_TEMPLATE
         #define HAS_MAP_AT
         #define HAS_ATTRIBUTE_SPECIFIERS
+        #define HAS_OVERRIDE
     #endif
 #endif