Merge pull request #1058 from ApexAI/iox-#415-add-event-parameter-to-…

…find-service

Iox #415 add event parameter to find service

CHANGELOG.md

@@ -26,6 +26,7 @@
 - Introduce `cxx::FunctionalInterface` to enrich nullable classes with `and_then`, `or_else`, `value_or`, `expect` [\#996](https://github.com/eclipse-iceoryx/iceoryx/issues/996)
 - Add C++17 `std::perms` as `cxx::perms` to `iceoryx_hoofs/cxx/filesystem.hpp`. [#1059](https://github.com/eclipse-iceoryx/iceoryx/issues/1059)
 - Support FreeBSD as a representative for the UNIX platforms [#1054](https://github.com/eclipse-iceoryx/iceoryx/issues/1054)
+- Add event parameter to `findService` method [#415](https://github.com/eclipse-iceoryx/iceoryx/issues/415)
 
 **Bugfixes:**
 
@@ -240,17 +241,21 @@ capro::ServiceDescription::deserialize(serialisedObj)
     });
 ```
 
-The service-related methods have been moved from `PoshRuntime` to `ServiceDiscovery`. Additionally, the
-`offerService` and `stopOfferService` methods have been removed:
+The service-related methods have been moved from `PoshRuntime` to `ServiceDiscovery`. The `offerService`
+and `stopOfferService` methods have been removed and `findService` has now an additional event paramter:
 
 ```cpp
 // before
+#include "iceoryx_posh/runtime/posh_runtime.hpp"
+
 poshRuntime.offerService(myServiceDescription);
 poshRuntime.stopOfferService(myServiceDescription);
 poshRuntime.findService({"ServiceA", iox::capro::AnyInstanceString});
 
 // after
-serviceDiscovery.findService("ServiceA", Wildcard);
+#include "iceoryx_posh/runtime/service_discovery.hpp"
+
+serviceDiscovery.findService("ServiceA", Wildcard, Wildcard);
 ```
 
 The `iox::cxx::expected` has dropped the requirement for `INVALID_STATE`. With this, the

iceoryx_posh/include/iceoryx_posh/internal/roudi/port_manager.hpp

@@ -97,7 +97,8 @@ class PortManager
 
     const std::atomic<uint64_t>* serviceRegistryChangeCounter() noexcept;
     runtime::IpcMessage findService(const cxx::optional<capro::IdString_t>& service,
-                                    const cxx::optional<capro::IdString_t>& instance) noexcept;
+                                    const cxx::optional<capro::IdString_t>& instance,
+                                    const cxx::optional<capro::IdString_t>& event) noexcept;
 
   protected:
     void makeAllPublisherPortsToStopOffer() noexcept;

iceoryx_posh/include/iceoryx_posh/internal/roudi/process_manager.hpp

@@ -109,7 +109,8 @@ class ProcessManager : public ProcessManagerInterface
 
     void findServiceForProcess(const RuntimeName_t& name,
                                const cxx::optional<capro::IdString_t>& service,
-                               const cxx::optional<capro::IdString_t>& instance) noexcept;
+                               const cxx::optional<capro::IdString_t>& instance,
+                               const cxx::optional<capro::IdString_t>& event) noexcept;
 
     void
     addInterfaceForProcess(const RuntimeName_t& name, capro::Interfaces interface, const NodeName_t& node) noexcept;

iceoryx_posh/include/iceoryx_posh/internal/roudi/service_registry.hpp

@@ -61,9 +61,11 @@ class ServiceRegistry
     /// @param[in] searchResult, reference to the vector which will be filled with the results
     /// @param[in] service, string or wildcard (= iox::cxx::nullopt) to search for
     /// @param[in] instance, string or wildcard (= iox::cxx::nullopt) to search for
+    /// @param[in] event, string or wildcard (= iox::cxx::nullopt) to search for
     void find(ServiceDescriptionVector_t& searchResult,
               const cxx::optional<capro::IdString_t>& service,
-              const cxx::optional<capro::IdString_t>& instance) const noexcept;
+              const cxx::optional<capro::IdString_t>& instance,
+              const cxx::optional<capro::IdString_t>& event) const noexcept;
 
     /// @brief Returns all service descriptions as copy
     /// @return ServiceDescriptionVector_t, copy of complete service registry
@@ -73,6 +75,7 @@ class ServiceRegistry
     /// @todo #859 replace std::multimap with prefix tree
     ::std::multimap<capro::IdString_t, uint64_t> m_serviceMap;
     ::std::multimap<capro::IdString_t, uint64_t> m_instanceMap;
+    ::std::multimap<capro::IdString_t, uint64_t> m_eventMap;
     ServiceDescriptionVector_t m_serviceDescriptionVector;
 };
 } // namespace roudi

iceoryx_posh/include/iceoryx_posh/runtime/service_discovery.hpp

@@ -37,12 +37,14 @@ class ServiceDiscovery
     /// @brief find all services that match the provided service description
     /// @param[in] service service string to search for, a nullopt corresponds to a wildcard
     /// @param[in] instance instance string to search for, a nullopt corresponds to a wildcard
+    /// @param[in] event event string to search for, a nullopt corresponds to a wildcard
     /// @return cxx::expected<ServiceContainer, FindServiceError>
     /// ServiceContainer: on success, container that is filled with all matching instances
     /// FindServiceError: if any, encountered during the operation
     cxx::expected<ServiceContainer, FindServiceError>
     findService(const cxx::optional<capro::IdString_t>& service,
-                const cxx::optional<capro::IdString_t>& instance) noexcept;
+                const cxx::optional<capro::IdString_t>& instance,
+                const cxx::optional<capro::IdString_t>& event) noexcept;
 
     /// @brief requests the serviceRegistryChangeCounter from the shared memory
     /// @return pointer to the serviceRegistryChangeCounter

iceoryx_posh/source/roudi/port_manager.cpp

@@ -559,12 +559,13 @@ void PortManager::destroySubscriberPort(SubscriberPortType::MemberType_t* const
 }
 
 runtime::IpcMessage PortManager::findService(const cxx::optional<capro::IdString_t>& service,
-                                             const cxx::optional<capro::IdString_t>& instance) noexcept
+                                             const cxx::optional<capro::IdString_t>& instance,
+                                             const cxx::optional<capro::IdString_t>& event) noexcept
 {
     runtime::IpcMessage response;
 
     ServiceRegistry::ServiceDescriptionVector_t searchResult;
-    m_serviceRegistry.find(searchResult, service, instance);
+    m_serviceRegistry.find(searchResult, service, instance, event);
 
     for (auto& service : searchResult)
     {

iceoryx_posh/source/roudi/process_manager.cpp

@@ -347,12 +347,13 @@ void ProcessManager::updateLivelinessOfProcess(const RuntimeName_t& name) noexce
 
 void ProcessManager::findServiceForProcess(const RuntimeName_t& name,
                                            const cxx::optional<capro::IdString_t>& service,
-                                           const cxx::optional<capro::IdString_t>& instance) noexcept
+                                           const cxx::optional<capro::IdString_t>& instance,
+                                           const cxx::optional<capro::IdString_t>& event) noexcept
 {
     searchForProcessAndThen(
         name,
         [&](Process& process) {
-            process.sendViaIpcChannel({m_portManager.findService(service, instance)});
+            process.sendViaIpcChannel({m_portManager.findService(service, instance, event)});
             LogDebug() << "Sent all found services to application " << name;
         },
         [&]() { LogWarn() << "Unknown process " << name << " requested to find services."; });

iceoryx_posh/source/roudi/roudi.cpp

@@ -346,7 +346,7 @@ void RouDi::processMessage(const runtime::IpcMessage& message,
     }
     case runtime::IpcMessageType::FIND_SERVICE:
     {
-        if (message.getNumberOfElements() != 6)
+        if (message.getNumberOfElements() != 8)
         {
             LogError() << "Wrong number of parameters for \"IpcMessageType::FIND_SERVICE\" from \"" << runtimeName
                        << "\"received!";
@@ -355,8 +355,10 @@ void RouDi::processMessage(const runtime::IpcMessage& message,
         {
             cxx::optional<capro::IdString_t> service;
             cxx::optional<capro::IdString_t> instance;
+            cxx::optional<capro::IdString_t> event;
             bool isServiceWildcard = false;
             bool isInstanceWildcard = false;
+            bool isEventWildcard = false;
             cxx::convert::fromString(message.getElementAtIndex(2).c_str(), isServiceWildcard);
             if (!isServiceWildcard)
             {
@@ -367,8 +369,13 @@ void RouDi::processMessage(const runtime::IpcMessage& message,
             {
                 instance.emplace(cxx::TruncateToCapacity, message.getElementAtIndex(5));
             }
+            cxx::convert::fromString(message.getElementAtIndex(6).c_str(), isEventWildcard);
+            if (!isEventWildcard)
+            {
+                event.emplace(cxx::TruncateToCapacity, message.getElementAtIndex(7));
+            }
 
-            m_prcMgr->findServiceForProcess(runtimeName, service, instance);
+            m_prcMgr->findServiceForProcess(runtimeName, service, instance, event);
         }
         break;
     }

iceoryx_posh/source/roudi/service_registry.cpp

@@ -45,6 +45,7 @@ cxx::expected<ServiceRegistry::Error> ServiceRegistry::add(const capro::ServiceD
     auto serviceIndex = m_serviceDescriptionVector.size() - 1;
     m_serviceMap.insert({serviceDescription.getServiceIDString(), serviceIndex});
     m_instanceMap.insert({serviceDescription.getInstanceIDString(), serviceIndex});
+    m_eventMap.insert({serviceDescription.getEventIDString(), serviceIndex});
     return cxx::success<>();
 }
 
@@ -96,19 +97,21 @@ void ServiceRegistry::remove(const capro::ServiceDescription& serviceDescription
     {
         removeIndexFromMap(m_serviceMap, index);
         removeIndexFromMap(m_instanceMap, index);
+        removeIndexFromMap(m_eventMap, index);
     }
 }
 
 void ServiceRegistry::find(ServiceDescriptionVector_t& searchResult,
                            const cxx::optional<capro::IdString_t>& service,
-                           const cxx::optional<capro::IdString_t>& instance) const noexcept
+                           const cxx::optional<capro::IdString_t>& instance,
+                           const cxx::optional<capro::IdString_t>& event) const noexcept
 {
-    cxx::vector<uint64_t, MAX_SERVICE_DESCRIPTIONS> intersection;
-
+    ServiceDescriptionVector_t serviceInstanceResult;
     // Find (K1, K2)
     // O(log n + log n + max(#PossibleServices + #possiblesInstances) + #intersection)
     if (instance && service)
     {
+        cxx::vector<uint64_t, MAX_SERVICE_DESCRIPTIONS> intersection;
         cxx::vector<uint64_t, MAX_SERVICE_DESCRIPTIONS> possibleServices;
         cxx::vector<uint64_t, MAX_SERVICE_DESCRIPTIONS> possibleInstances;
 
@@ -132,7 +135,7 @@ void ServiceRegistry::find(ServiceDescriptionVector_t& searchResult,
 
         for (auto& value : intersection)
         {
-            searchResult.push_back(m_serviceDescriptionVector[value]);
+            serviceInstanceResult.push_back(m_serviceDescriptionVector[value]);
         }
     }
     // Find (*, K2)
@@ -142,7 +145,7 @@ void ServiceRegistry::find(ServiceDescriptionVector_t& searchResult,
         auto range = m_instanceMap.equal_range(instance.value());
         for (auto entry = range.first; entry != range.second; ++entry)
         {
-            searchResult.push_back(m_serviceDescriptionVector[entry->second]);
+            serviceInstanceResult.push_back(m_serviceDescriptionVector[entry->second]);
         }
     }
     // Find (K1, *)
@@ -152,14 +155,29 @@ void ServiceRegistry::find(ServiceDescriptionVector_t& searchResult,
         auto range = m_serviceMap.equal_range(service.value());
         for (auto entry = range.first; entry != range.second; ++entry)
         {
-            searchResult.push_back(m_serviceDescriptionVector[entry->second]);
+            serviceInstanceResult.push_back(m_serviceDescriptionVector[entry->second]);
         }
     }
     else
     {
         // Find (*, *)
         // O(n)
-        searchResult = m_serviceDescriptionVector;
+        serviceInstanceResult = m_serviceDescriptionVector;
+    }
+
+    if (event)
+    {
+        for (auto iterator = serviceInstanceResult.begin(); iterator != serviceInstanceResult.end(); iterator++)
+        {
+            if (iterator->serviceDescription.getEventIDString() == event.value())
+            {
+                searchResult.push_back(*iterator);
+            }
+        }
+    }
+    else
+    {
+        searchResult = serviceInstanceResult;
     }
 }
 

iceoryx_posh/source/runtime/service_discovery.cpp

@@ -23,13 +23,16 @@ namespace runtime
 {
 cxx::expected<ServiceContainer, FindServiceError>
 ServiceDiscovery::findService(const cxx::optional<capro::IdString_t>& service,
-                              const cxx::optional<capro::IdString_t>& instance) noexcept
+                              const cxx::optional<capro::IdString_t>& instance,
+                              const cxx::optional<capro::IdString_t>& event) noexcept
 {
     /// @todo #415 remove the string mapping, once the find call is done via shared memory
     capro::IdString_t serviceString;
     capro::IdString_t instanceString;
+    capro::IdString_t eventString;
     bool isServiceWildcard = !service;
     bool isInstanceWildcard = !instance;
+    bool isEventWildcard = !event;
 
     if (!isServiceWildcard)
     {
@@ -39,11 +42,16 @@ ServiceDiscovery::findService(const cxx::optional<capro::IdString_t>& service,
     {
         instanceString = instance.value();
     }
+    if (!isEventWildcard)
+    {
+        eventString = event.value();
+    }
 
     IpcMessage sendBuffer;
     sendBuffer << IpcMessageTypeToString(IpcMessageType::FIND_SERVICE) << PoshRuntime::getInstance().getInstanceName()
                << cxx::convert::toString(isServiceWildcard) << serviceString
-               << cxx::convert::toString(isInstanceWildcard) << instanceString;
+               << cxx::convert::toString(isInstanceWildcard) << instanceString
+               << cxx::convert::toString(isEventWildcard) << eventString;
 
     IpcMessage requestResponse;