Trackers.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#pragma once
 
#include <memory>
#include <mutex>
#include <atomic>
#include <cassert>
#include <set>
#include <unordered_map>
#include <functional>
#include <thread>
 
#include "celix_utils.h"
#include "celix_bundle_context.h"
#include "celix_framework.h"
#include "celix/FrameworkExceptions.h"
#include "celix/Properties.h"
#include "celix/Utils.h"
#include "celix/Bundle.h"
#include "celix/Constants.h"
#include "celix/Filter.h"
 
namespace celix {
 
 
    enum class TrackerState : std::uint8_t {
        OPENING,
        OPEN,
        CLOSING,
        CLOSED
    };
 
    class AbstractTracker {
    public:
        explicit AbstractTracker(std::shared_ptr<celix_bundle_context_t> _cCtx) :
            cCtx{std::move(_cCtx)} {}
 
        virtual ~AbstractTracker() noexcept = default;
 
        bool isOpen() const {
            std::lock_guard<std::mutex> lck{mutex};
            return state == TrackerState::OPEN;
        }
 
        TrackerState getState() const {
            std::lock_guard<std::mutex> lck{mutex};
            return state;
        }
 
        void close() {
            long localTrkId = -1;
            {
                std::lock_guard<std::mutex> lck{mutex};
                if (state == TrackerState::OPEN || state == TrackerState::OPENING) {
                    //not yet closed
                    state = TrackerState::CLOSING;
                    localTrkId = trkId;
                    trkId = -1;
                }
            }
            if (localTrkId >= 0) {
                celix_bundleContext_stopTracker(cCtx.get(), localTrkId);
                {
                    std::lock_guard<std::mutex> lck{mutex};
                    state = TrackerState::CLOSED;
                }
            }
        }
 
        virtual void open() = 0;
 
        void wait() const {
            bool needWaitOpening = false;
            bool needWaitClosing = false;
            long localId;
            {
                std::lock_guard<std::mutex> lck{mutex};
                localId = trkId;
                if (state == TrackerState::OPENING) {
                    needWaitOpening = true;
                } else if (state == TrackerState::CLOSING) {
                    needWaitClosing = true;
                }
            }
            if (needWaitOpening) {
                celix_bundleContext_waitForAsyncTracker(cCtx.get(), localId);
            }
            if (needWaitClosing) {
                celix_bundleContext_waitForAsyncStopTracker(cCtx.get(), localId);
            }
        }
    protected:
        void waitIfAble() const {
            auto* fw = celix_bundleContext_getFramework(cCtx.get());
            if (!celix_framework_isCurrentThreadTheEventLoop(fw)) {
                wait();
            }
        }
 
        template<typename T>
        static std::function<void(T*)> delCallback() {
            return [](T *tracker) {
                if (tracker->getState() == TrackerState::CLOSED) {
                    delete tracker;
                } else {
                    /*
                     * if open/opening -> close() -> new event on the Celix event thread
                     * if closing -> nop close() -> there is already a event on the Celix event thread to close
                     */
                    tracker->close();
 
                    /*
                     * Creating event on the Event loop, this will be after the close is done
                     */
                    auto *fw = celix_bundleContext_getFramework(tracker->cCtx.get());
                    auto *bnd = celix_bundleContext_getBundle(tracker->cCtx.get());
                    long bndId = celix_bundle_getId(bnd);
                    celix_framework_fireGenericEvent(
                            fw,
                            -1,
                            bndId,
                            "celix::AbstractTracker delete callback",
                            tracker,
                            [](void *data) {
                                auto *t = static_cast<AbstractTracker *>(data);
                                delete t;
                            },
                            nullptr,
                            nullptr);
                }
            };
        }
 
        const std::shared_ptr<celix_bundle_context_t> cCtx;
 
        mutable std::mutex mutex{}; //protects below
        long trkId{-1L};
        TrackerState state{TrackerState::CLOSED};
    };
 
    class GenericServiceTracker : public AbstractTracker {
    public:
#if __cplusplus >= 201703L //C++17 or higher
        GenericServiceTracker(std::shared_ptr<celix_bundle_context_t> _cCtx, std::string_view _svcName,
                              std::string_view _svcVersionRange, celix::Filter _filter) : AbstractTracker{std::move(_cCtx)}, svcName{_svcName},
                                                                                   svcVersionRange{_svcVersionRange}, filter{std::move(_filter)} {
            setupServiceTrackerOptions();
        }
#else
        GenericServiceTracker(std::shared_ptr<celix_bundle_context_t> _cCtx, std::string _svcName,
                              std::string _svcVersionRange, celix::Filter _filter) : AbstractTracker{std::move(_cCtx)}, svcName{std::move(_svcName)},
                                                                                   svcVersionRange{std::move(_svcVersionRange)}, filter{std::move(_filter)} {
            setupServiceTrackerOptions();
        }
#endif
 
        ~GenericServiceTracker() override = default;
 
        void open() override {
            std::lock_guard<std::mutex> lck{mutex};
            if (state == TrackerState::CLOSED || state == TrackerState::CLOSING) {
                state = TrackerState::OPENING;
 
                //NOTE assuming the opts already configured the callbacks
                trkId = celix_bundleContext_trackServicesWithOptionsAsync(cCtx.get(), &opts);
                if (trkId < 0) {
                    throw celix::TrackerException{"Cannot open service tracker"};
                }
            }
        }
 
        const std::string& getServiceName() const { return svcName; }
 
        const std::string& getServiceRange() const { return svcVersionRange; }
 
        const celix::Filter& getFilter() const { return filter; }
 
        std::size_t getServiceCount() const {
            return svcCount;
        }
    protected:
        const std::string svcName;
        const std::string svcVersionRange;
        const celix::Filter filter;
        celix_service_tracking_options opts{}; //note only set in the ctor
        std::atomic<size_t> svcCount{0};
 
    private:
        void setupServiceTrackerOptions() {
            opts.trackerCreatedCallbackData = this;
            opts.trackerCreatedCallback = [](void *data) {
                auto* trk = static_cast<GenericServiceTracker*>(data);
                {
                    std::lock_guard<std::mutex> callbackLock{trk->mutex};
                    trk->state = TrackerState::OPEN;
                }
            };
        }
    };
 
    template<typename I>
    class ServiceTracker : public GenericServiceTracker {
    public:
#if __cplusplus >= 201703L //C++17 or higher
        static std::shared_ptr<ServiceTracker<I>> create(
                std::shared_ptr<celix_bundle_context_t> cCtx,
                std::string_view svcName,
                std::string_view svcVersionRange,
                celix::Filter filter,
                std::vector<std::function<void(const std::shared_ptr<I>&, const std::shared_ptr<const celix::Properties>&, const std::shared_ptr<const celix::Bundle>&)>> setCallbacks,
                std::vector<std::function<void(const std::shared_ptr<I>&, const std::shared_ptr<const celix::Properties>&, const std::shared_ptr<const celix::Bundle>&)>> addCallbacks,
                std::vector<std::function<void(const std::shared_ptr<I>&, const std::shared_ptr<const celix::Properties>&, const std::shared_ptr<const celix::Bundle>&)>> remCallbacks) {
            auto tracker = std::shared_ptr<ServiceTracker<I>>{
                new ServiceTracker<I>{
                    std::move(cCtx),
                    svcName,
                    svcVersionRange,
                    std::move(filter),
                    std::move(setCallbacks),
                    std::move(addCallbacks),
                    std::move(remCallbacks)},
                AbstractTracker::delCallback<ServiceTracker<I>>()};
            tracker->open();
            return tracker;
        }
#else
        static std::shared_ptr<ServiceTracker<I>> create(
                std::shared_ptr<celix_bundle_context_t> cCtx,
                std::string svcName,
                std::string svcVersionRange,
                celix::Filter filter,
                std::vector<std::function<void(const std::shared_ptr<I>&, const std::shared_ptr<const celix::Properties>&, const std::shared_ptr<const celix::Bundle>&)>> setCallbacks,
                std::vector<std::function<void(const std::shared_ptr<I>&, const std::shared_ptr<const celix::Properties>&, const std::shared_ptr<const celix::Bundle>&)>> addCallbacks,
                std::vector<std::function<void(const std::shared_ptr<I>&, const std::shared_ptr<const celix::Properties>&, const std::shared_ptr<const celix::Bundle>&)>> remCallbacks) {
            auto tracker = std::shared_ptr<ServiceTracker<I>>{
                new ServiceTracker<I>{
                    std::move(cCtx),
                    std::move(svcName),
                    std::move(svcVersionRange),
                    std::move(filter),
                    std::move(setCallbacks),
                    std::move(addCallbacks),
                    std::move(remCallbacks)},
                AbstractTracker::delCallback<ServiceTracker<I>>()};
            tracker->open();
            return tracker;
        }
#endif
 
        std::shared_ptr<I> getHighestRankingService() {
            waitIfAble();
            std::shared_ptr<I> result{};
            std::lock_guard<std::mutex> lck{mutex};
            auto it = entries.begin();
            if (it != entries.end()) {
                result = (*it)->svc;
            }
            return result;
        }
 
        std::vector<std::shared_ptr<I>> getServices() {
            waitIfAble();
            std::vector<std::shared_ptr<I>> result{};
            std::lock_guard<std::mutex> lck{mutex};
            result.reserve(entries.size());
            for (auto& e : entries) {
                result.push_back(e->svc);
            }
            return result;
        }
    protected:
        struct SvcEntry {
            SvcEntry(long _svcId, long _svcRanking, std::shared_ptr<I> _svc,
                     std::shared_ptr<const celix::Properties> _properties,
                     std::shared_ptr<const celix::Bundle> _owner) : svcId(_svcId), svcRanking(_svcRanking),
                                                                          svc(std::move(_svc)),
                                                                          properties(std::move(_properties)),
                                                                          owner(std::move(_owner)) {}
            long svcId;
            long svcRanking;
            std::shared_ptr<I> svc;
            std::shared_ptr<const celix::Properties> properties;
            std::shared_ptr<const celix::Bundle> owner;
        };
 
#if __cplusplus >= 201703L //C++17 or higher
        ServiceTracker(std::shared_ptr<celix_bundle_context_t> _cCtx, std::string_view _svcName,
                       std::string_view _svcVersionRange, celix::Filter _filter,
                       std::vector<std::function<void(const std::shared_ptr<I>&, const std::shared_ptr<const celix::Properties>&, const std::shared_ptr<const celix::Bundle>&)>> _setCallbacks,
                       std::vector<std::function<void(const std::shared_ptr<I>&, const std::shared_ptr<const celix::Properties>&, const std::shared_ptr<const celix::Bundle>&)>> _addCallbacks,
                       std::vector<std::function<void(const std::shared_ptr<I>&, const std::shared_ptr<const celix::Properties>&, const std::shared_ptr<const celix::Bundle>&)>> _remCallbacks) :
                GenericServiceTracker{std::move(_cCtx), _svcName, _svcVersionRange, std::move(_filter)},
                setCallbacks{std::move(_setCallbacks)},
                addCallbacks{std::move(_addCallbacks)},
                remCallbacks{std::move(_remCallbacks)} {
            setupServiceTrackerOptions();
        }
#else
        ServiceTracker(std::shared_ptr<celix_bundle_context_t> _cCtx, std::string _svcName,
                       std::string _svcVersionRange, celix::Filter _filter,
                       std::vector<std::function<void(const std::shared_ptr<I>&, const std::shared_ptr<const celix::Properties>&, const std::shared_ptr<const celix::Bundle>&)>> _setCallbacks,
                       std::vector<std::function<void(const std::shared_ptr<I>&, const std::shared_ptr<const celix::Properties>&, const std::shared_ptr<const celix::Bundle>&)>> _addCallbacks,
                       std::vector<std::function<void(const std::shared_ptr<I>&, const std::shared_ptr<const celix::Properties>&, const std::shared_ptr<const celix::Bundle>&)>> _remCallbacks) :
                GenericServiceTracker{std::move(_cCtx), std::move(_svcName), std::move(_svcVersionRange), std::move(_filter)},
                setCallbacks{std::move(_setCallbacks)},
                addCallbacks{std::move(_addCallbacks)},
                remCallbacks{std::move(_remCallbacks)} {
            setupServiceTrackerOptions();
        }
#endif
 
        static std::shared_ptr<SvcEntry> createEntry(void* voidSvc, const celix_properties_t* cProps, const celix_bundle_t* cBnd) {
            long svcId = celix_properties_getAsLong(cProps, OSGI_FRAMEWORK_SERVICE_ID, -1L);
            long svcRanking = celix_properties_getAsLong(cProps, OSGI_FRAMEWORK_SERVICE_RANKING, 0);
            auto svc = std::shared_ptr<I>{static_cast<I*>(voidSvc), [](I*){/*nop*/}};
            auto props = celix::Properties::wrap(cProps);
            auto owner = std::make_shared<celix::Bundle>(const_cast<celix_bundle_t*>(cBnd));
            return std::make_shared<SvcEntry>(svcId, svcRanking, svc, props, owner);
        }
 
        void waitForExpiredSvcEntry(std::shared_ptr<SvcEntry>& entry) {
            if (entry) {
                std::weak_ptr<void> svcObserve = entry->svc;
                std::weak_ptr<const celix::Properties> propsObserve = entry->properties;
                std::weak_ptr<const celix::Bundle> ownerObserve = entry->owner;
                entry->svc = nullptr;
                entry->properties = nullptr;
                entry->owner = nullptr;
                waitForExpired(svcObserve, entry->svcId, "service");
                waitForExpired(propsObserve, entry->svcId, "service properties");
                waitForExpired(ownerObserve, entry->svcId, "service bundle (owner)");
            }
        }
 
        template<typename U>
        void waitForExpired(std::weak_ptr<U> observe, long svcId, const char* objName) {
            auto start = std::chrono::system_clock::now();
            while (!observe.expired()) {
                auto now = std::chrono::system_clock::now();
                auto durationInMilli = std::chrono::duration_cast<std::chrono::milliseconds>(now - start);
                if (durationInMilli > warningTimoutForNonExpiredSvcObject) {
                    celix_bundleContext_log(cCtx.get(), CELIX_LOG_LEVEL_WARNING, "Cannot remove %s associated with service.id %li, because it is still in use. Current shared_ptr use count is %i\n", objName, svcId, (int)observe.use_count());
                    start = now;
                }
                std::this_thread::sleep_for(std::chrono::milliseconds{50});
            }
        }
 
        void invokeUpdateCallbacks() {
            if (!updateCallbacks.empty()) {
                std::vector<std::shared_ptr<I>> updateVector{};
                {
                    std::lock_guard<std::mutex> lck{mutex};
                    updateVector.reserve(entries.size());
                    for (const auto &entry :  entries) {
                        updateVector.push_back(entry->svc);
                    }
                }
                for (const auto& cb : updateCallbacks) {
                    cb(updateVector);
                }
            }
            if (!updateWithPropertiesCallbacks.empty()) {
                std::vector<std::pair<std::shared_ptr<I>, std::shared_ptr<const celix::Properties>>> updateVector{};
                updateVector.reserve(entries.size());
                {
                    std::lock_guard<std::mutex> lck{mutex};
                    for (const auto &entry :  entries) {
                        updateVector.emplace_back(entry->svc, entry->properties);
                    }
                }
                for (const auto& cb : updateWithPropertiesCallbacks) {
                    cb(updateVector);
                }
            }
            if (!updateWithOwnerCallbacks.empty()) {
                std::vector<std::tuple<std::shared_ptr<I>, std::shared_ptr<const celix::Properties>, std::shared_ptr<const celix::Bundle>>> updateVector{};
                updateVector.reserve(entries.size());
                {
                    std::lock_guard<std::mutex> lck{mutex};
                    for (const auto &entry :  entries) {
                        updateVector.emplace_back(entry->svc, entry->properties, entry->owner);
                    }
                }
                for (const auto& cb : updateWithOwnerCallbacks) {
                    cb(updateVector);
                }
            }
        }
 
        const std::chrono::milliseconds warningTimoutForNonExpiredSvcObject{1000};
 
        const std::vector<std::function<void(const std::shared_ptr<I>&, const std::shared_ptr<const celix::Properties>&, const std::shared_ptr<const celix::Bundle>&)>> setCallbacks;
        const std::vector<std::function<void(const std::shared_ptr<I>&, const std::shared_ptr<const celix::Properties>&, const std::shared_ptr<const celix::Bundle>&)>> addCallbacks;
        const std::vector<std::function<void(const std::shared_ptr<I>&, const std::shared_ptr<const celix::Properties>&, const std::shared_ptr<const celix::Bundle>&)>> remCallbacks;
 
        //NOTE update callbacks cannot yet be configured
        const std::vector<std::function<void(const std::vector<std::shared_ptr<I>>)>> updateCallbacks{};
        const std::vector<std::function<void(const std::vector<std::pair<std::shared_ptr<I>, std::shared_ptr<const celix::Properties>>>)>> updateWithPropertiesCallbacks{};
        const std::vector<std::function<void(const std::vector<std::tuple<std::shared_ptr<I>, std::shared_ptr<const celix::Properties>, std::shared_ptr<const celix::Bundle>>>)>> updateWithOwnerCallbacks{};
 
        struct SvcEntryCompare {
            bool operator() (const std::shared_ptr<SvcEntry>& a, const std::shared_ptr<SvcEntry>& b) const {
                int cmp = celix_utils_compareServiceIdsAndRanking(a->svcId, a->svcRanking, b->svcId, b->svcRanking);
                return cmp < 0;
            }
        };
 
        mutable std::mutex mutex{}; //protect below
        std::set<std::shared_ptr<SvcEntry>, SvcEntryCompare> entries{};
        std::unordered_map<long, std::shared_ptr<SvcEntry>> cachedEntries{};
        std::shared_ptr<SvcEntry> highestRankingServiceEntry{};
 
    private:
        void setupServiceTrackerOptions() {
            opts.filter.serviceName = svcName.empty() ? nullptr : svcName.c_str();
            opts.filter.versionRange = svcVersionRange.empty() ? nullptr : svcVersionRange.c_str();
            opts.filter.filter = filter.empty() ? nullptr : filter.getFilterCString();
            opts.callbackHandle = this;
            opts.addWithOwner = [](void *handle, void *voidSvc, const celix_properties_t* cProps, const celix_bundle_t* cBnd) {
                auto tracker = static_cast<ServiceTracker<I>*>(handle);
                auto entry = createEntry(voidSvc, cProps, cBnd);
                {
                    std::lock_guard<std::mutex> lck{tracker->mutex};
                    tracker->entries.insert(entry);
                    tracker->cachedEntries[entry->svcId] = entry;
                }
                tracker->svcCount.fetch_add(1, std::memory_order_relaxed);
                for (const auto& cb : tracker->addCallbacks) {
                    cb(entry->svc, entry->properties, entry->owner);
                }
                tracker->invokeUpdateCallbacks();
            };
            opts.removeWithOwner = [](void *handle, void*, const celix_properties_t* cProps, const celix_bundle_t*) {
                auto tracker = static_cast<ServiceTracker<I>*>(handle);
                long svcId = celix_properties_getAsLong(cProps, OSGI_FRAMEWORK_SERVICE_ID, -1L);
                std::shared_ptr<SvcEntry> entry{};
                {
                    std::lock_guard<std::mutex> lck{tracker->mutex};
                    auto it = tracker->cachedEntries.find(svcId);
                    assert(it != tracker->cachedEntries.end()); //should not happen, added during add callback
                    entry = it->second;
                    tracker->cachedEntries.erase(it);
                    tracker->entries.erase(entry);
                }
                for (const auto& cb : tracker->remCallbacks) {
                    cb(entry->svc, entry->properties, entry->owner);
                }
                tracker->invokeUpdateCallbacks();
                tracker->svcCount.fetch_sub(1, std::memory_order_relaxed);
                tracker->waitForExpiredSvcEntry(entry);
            };
            opts.setWithOwner = [](void *handle, void *voidSvc, const celix_properties_t *cProps, const celix_bundle_t *cBnd) {
                auto tracker = static_cast<ServiceTracker<I>*>(handle);
                std::unique_lock<std::mutex> lck{tracker->mutex};
                auto prevEntry = tracker->highestRankingServiceEntry;
                if (voidSvc) {
                    tracker->highestRankingServiceEntry = createEntry(voidSvc, cProps, cBnd);
                } else {
                    tracker->highestRankingServiceEntry = nullptr;
                }
                for (const auto& cb : tracker->setCallbacks) {
                    if (tracker->highestRankingServiceEntry) {
                        auto& e = tracker->highestRankingServiceEntry;
                        cb(e->svc, e->properties, e->owner);
                    } else /*"unset"*/ {
                        cb(nullptr, nullptr, nullptr);
                    }
                }
                lck.unlock();
                tracker->waitForExpiredSvcEntry(prevEntry);
            };
        }
    };
 
    class BundleTracker : public AbstractTracker {
    public:
        static std::shared_ptr<BundleTracker> create(
                std::shared_ptr<celix_bundle_context_t> cCtx,
                bool includeFrameworkBundle,
                std::vector<std::function<void(const celix::Bundle&)>> onInstallCallbacks,
                std::vector<std::function<void(const celix::Bundle&)>> onStartCallbacks,
                std::vector<std::function<void(const celix::Bundle&)>> onStopCallbacks) {
 
            auto tracker = std::shared_ptr<BundleTracker>{
                    new BundleTracker{
                            std::move(cCtx),
                            includeFrameworkBundle,
                            std::move(onInstallCallbacks),
                            std::move(onStartCallbacks),
                            std::move(onStopCallbacks)},
                    AbstractTracker::delCallback<BundleTracker>()};
            tracker->open();
            return tracker;
        }
 
        void open() override {
            std::lock_guard<std::mutex> lck{mutex};
            if (state == TrackerState::CLOSED || state == TrackerState::CLOSING) {
                state = TrackerState::OPENING;
                //NOTE the opts already configured the callbacks
                trkId = celix_bundleContext_trackBundlesWithOptionsAsync(cCtx.get(), &opts);
                if (trkId < 0) {
                    throw celix::TrackerException{"Cannot open bundle tracker"};
                }
            }
        }
    private:
        BundleTracker(
                std::shared_ptr<celix_bundle_context_t> _cCtx,
                bool _includeFrameworkBundle,
                std::vector<std::function<void(const celix::Bundle&)>> _onInstallCallbacks,
                std::vector<std::function<void(const celix::Bundle&)>> _onStartCallbacks,
                std::vector<std::function<void(const celix::Bundle&)>> _onStopCallbacks) :
                AbstractTracker{std::move(_cCtx)},
                includeFrameworkBundle{_includeFrameworkBundle},
                onInstallCallbacks{std::move(_onInstallCallbacks)},
                onStartCallbacks{std::move(_onStartCallbacks)},
                onStopCallbacks{std::move(_onStopCallbacks)} {
 
 
            opts.includeFrameworkBundle = includeFrameworkBundle;
            opts.callbackHandle = this;
            opts.onInstalled = [](void *handle, const celix_bundle_t *cBnd) {
                auto tracker = static_cast<BundleTracker *>(handle);
                celix::Bundle bnd{const_cast<celix_bundle_t *>(cBnd)};
                for (const auto& cb : tracker->onInstallCallbacks) {
                    cb(bnd);
                }
            };
            opts.onStarted = [](void *handle, const celix_bundle_t *cBnd) {
                auto tracker = static_cast<BundleTracker *>(handle);
                celix::Bundle bnd{const_cast<celix_bundle_t *>(cBnd)};
                for (const auto& cb : tracker->onStartCallbacks) {
                    cb(bnd);
                }
            };
            opts.onStopped = [](void *handle, const celix_bundle_t *cBnd) {
                auto tracker = static_cast<BundleTracker *>(handle);
                celix::Bundle bnd{const_cast<celix_bundle_t *>(cBnd)};
                for (const auto& cb : tracker->onStopCallbacks) {
                    cb(bnd);
                }
            };
            opts.trackerCreatedCallbackData = this;
            opts.trackerCreatedCallback = [](void *data) {
                auto* trk = static_cast<BundleTracker*>(data);
                std::lock_guard<std::mutex> callbackLock{trk->mutex};
                trk->state = TrackerState::OPEN;
            };
        }
 
        const bool includeFrameworkBundle;
        const std::vector<std::function<void(const celix::Bundle&)>> onInstallCallbacks;
        const std::vector<std::function<void(const celix::Bundle&)>> onStartCallbacks;
        const std::vector<std::function<void(const celix::Bundle&)>> onStopCallbacks;
        celix_bundle_tracking_options_t opts{}; //note only set in the ctor
    };
 
 
    struct ServiceTrackerInfo {
        const std::string serviceName;
 
        const celix::Filter filter;
 
        const long trackerOwnerBundleId;
    };
 
    class MetaTracker : public AbstractTracker {
    public:
 
#if __cplusplus >= 201703L //C++17 or higher
        static std::shared_ptr<MetaTracker> create(
                std::shared_ptr<celix_bundle_context_t> cCtx,
                std::string_view serviceName,
                std::vector<std::function<void(const ServiceTrackerInfo&)>> onTrackerCreated,
                std::vector<std::function<void(const ServiceTrackerInfo&)>> onTrackerDestroyed) {
            auto tracker = std::shared_ptr<MetaTracker>{
                    new MetaTracker{
                            std::move(cCtx),
                            std::string{serviceName},
                            std::move(onTrackerCreated),
                            std::move(onTrackerDestroyed)},
                    AbstractTracker::delCallback<MetaTracker>()};
            tracker->open();
            return tracker;
        }
#else
        static std::shared_ptr<MetaTracker> create(
                std::shared_ptr<celix_bundle_context_t> cCtx,
                std::string serviceName,
                std::vector<std::function<void(const ServiceTrackerInfo&)>> onTrackerCreated,
                std::vector<std::function<void(const ServiceTrackerInfo&)>> onTrackerDestroyed) {
            auto tracker = std::shared_ptr<MetaTracker>{
                    new MetaTracker{
                            std::move(cCtx),
                            std::move(serviceName),
                            std::move(onTrackerCreated),
                            std::move(onTrackerDestroyed)},
                    AbstractTracker::delCallback<MetaTracker>()};
            tracker->open();
            return tracker;
        }
#endif
 
        void open() override {
            std::lock_guard<std::mutex> lck{mutex};
            if (state == TrackerState::CLOSED || state == TrackerState::CLOSING) {
                state = TrackerState::OPENING;
 
                //NOTE the opts already configured the callbacks
                trkId = celix_bundleContext_trackServiceTrackersAsync(
                        cCtx.get(),
                        serviceName.empty() ? nullptr : serviceName.c_str(),
                        static_cast<void*>(this),
                        [](void *handle, const celix_service_tracker_info_t *cInfo) {
                            auto *trk = static_cast<MetaTracker *>(handle);
                            std::string svcName = cInfo->serviceName == nullptr ? "" : cInfo->serviceName;
                            ServiceTrackerInfo info{svcName, celix::Filter::wrap(cInfo->filter), cInfo->bundleId};
                            for (const auto& cb : trk->onTrackerCreated) {
                                cb(info);
                            }
                        },
                        [](void *handle, const celix_service_tracker_info_t *cInfo) {
                            auto *trk = static_cast<MetaTracker *>(handle);
                            std::string svcName = cInfo->serviceName == nullptr ? "" : cInfo->serviceName;
                            ServiceTrackerInfo info{svcName, celix::Filter::wrap(cInfo->filter), cInfo->bundleId};
                            for (const auto& cb : trk->onTrackerDestroyed) {
                                cb(info);
                            }
                        },
                        static_cast<void*>(this),
                        [](void *data) {
                            auto *trk = static_cast<MetaTracker *>(data);
                            std::lock_guard<std::mutex> callbackLock{trk->mutex};
                            trk->state = TrackerState::OPEN;
                        });
                if (trkId < 0) {
                    throw celix::TrackerException{"Cannot open meta tracker"};
                }
            }
        }
 
    private:
        MetaTracker(
                std::shared_ptr<celix_bundle_context_t> _cCtx,
                std::string _serviceName,
                std::vector<std::function<void(const ServiceTrackerInfo&)>> _onTrackerCreated,
                std::vector<std::function<void(const ServiceTrackerInfo&)>> _onTrackerDestroyed) :
                AbstractTracker{std::move(_cCtx)},
                serviceName{std::move(_serviceName)},
                onTrackerCreated{std::move(_onTrackerCreated)},
                onTrackerDestroyed{std::move(_onTrackerDestroyed)} {}
 
        const std::string serviceName;
        const std::vector<std::function<void(const ServiceTrackerInfo&)>> onTrackerCreated;
        const std::vector<std::function<void(const ServiceTrackerInfo&)>> onTrackerDestroyed;
    };
 
}