summaryrefslogtreecommitdiff
path: root/src/CommonAPI/DBus/DBusServiceRegistry.cpp
blob: f8837978357712582eaf1559f010e0323197fd22 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
/* Copyright (C) 2013 BMW Group
 * Author: Manfred Bathelt (manfred.bathelt@bmw.de)
 * Author: Juergen Gehring (juergen.gehring@bmw.de)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "DBusFunctionalHash.h"
#include "DBusServiceRegistry.h"
#include "DBusDaemonProxy.h"
#include "DBusProxyAsyncCallbackHandler.h"

namespace CommonAPI {
namespace DBus {


DBusServiceRegistry::DBusServiceRegistry(std::shared_ptr<DBusProxyConnection> dbusProxyConnection):
                dbusDaemonProxy_(std::make_shared<CommonAPI::DBus::DBusDaemonProxy>(dbusProxyConnection)),
                dbusServicesStatus_(AvailabilityStatus::UNKNOWN) {

    dbusDaemonProxyStatusEventSubscription_ =
                    dbusDaemonProxy_->getProxyStatusEvent().subscribeCancellableListener(
                                    std::bind(&DBusServiceRegistry::onDBusDaemonProxyStatusEvent, this, std::placeholders::_1));

    dbusDaemonProxyNameOwnerChangedEventSubscription_ =
                    dbusDaemonProxy_->getNameOwnerChangedEvent().subscribeCancellableListener(
                    std::bind(&DBusServiceRegistry::onDBusDaemonProxyNameOwnerChangedEvent,
                              this,
                              std::placeholders::_1,
                              std::placeholders::_2,
                              std::placeholders::_3));
}

DBusServiceRegistry::~DBusServiceRegistry() {
    dbusDaemonProxy_->getNameOwnerChangedEvent().unsubscribe(dbusDaemonProxyNameOwnerChangedEventSubscription_);
    dbusDaemonProxy_->getProxyStatusEvent().unsubscribe(dbusDaemonProxyStatusEventSubscription_);
}

bool DBusServiceRegistry::waitDBusServicesAvailable(std::unique_lock<std::mutex>& lock, std::chrono::milliseconds& timeout) {
    bool dbusServicesStatusIsKnown = (dbusServicesStatus_ != AvailabilityStatus::UNKNOWN);

    while (!dbusServicesStatusIsKnown && timeout.count() > 0) {
        typedef std::chrono::high_resolution_clock clock;
        clock::time_point startTimePoint = clock::now();

        dbusServicesStatusIsKnown = dbusServiceChanged_.wait_for(
                                        lock,
                                        timeout,
                                        [&]{ return dbusServicesStatus_ != AvailabilityStatus::UNKNOWN; });

        std::chrono::milliseconds elapsedWaitTime =
                                    std::chrono::duration_cast<std::chrono::milliseconds>(clock::now() - startTimePoint);

        if (elapsedWaitTime > timeout) {
            timeout = std::chrono::milliseconds::zero();
            break;
        }

        timeout -= elapsedWaitTime;
    }

    return (dbusServicesStatus_ == AvailabilityStatus::AVAILABLE);
}

bool DBusServiceRegistry::isServiceInstanceAlive(const std::string& dbusInterfaceName, const std::string& dbusServiceName, const std::string& dbusObjectPath) {
    if (!dbusDaemonProxy_->isAvailable()) {
        return false;
    }

    std::chrono::milliseconds timeout(2000);
    std::unique_lock<std::mutex> dbusServicesLock(dbusServicesMutex_);

    if (!waitDBusServicesAvailable(dbusServicesLock, timeout)) {
        return false;
    }

    auto dbusServiceIterator = dbusServices_.find(dbusServiceName);
    if (dbusServiceIterator == dbusServices_.end()) {
        return false;
    }

    DBusServiceState& dbusServiceState = dbusServiceIterator->second.first;

    if (dbusServiceState == DBusServiceState::AVAILABLE) {
        resolveDBusServiceInstances(dbusServiceIterator);
    }

    if (dbusServiceState == DBusServiceState::RESOLVING) {
        dbusServiceChanged_.wait_for(
                        dbusServicesLock,
                        timeout,
                        [&] { return dbusServiceState != DBusServiceState::RESOLVING; });
    }

    const DBusInstanceList& dbusInstanceList = dbusServiceIterator->second.second;
    auto dbusInstanceIterator = dbusInstanceList.find({ dbusObjectPath, dbusInterfaceName });

    if (dbusInstanceIterator != dbusInstanceList.end()) {
        const AvailabilityStatus& dbusInstanceAvailabilityStatus = dbusInstanceIterator->second.first;

        return (dbusInstanceAvailabilityStatus == AvailabilityStatus::AVAILABLE);
    }

    return false;
}

// Go through the list of available services and check their interface lists
// If a list is still unknown, then send request to the remote object manager and count it as invalid
// If a list is in acquiring state, then just count it as invalid and skip over it
// Add all matching valid services to the available service list
// If the invalid service count is set, then wait upto waitTimeLimit (2 seconds) for the object manager requests to complete
// If the timeout expires, then go through the list for last time and add everything matching
// If the timeout didn't expire, then go through the list again and send requests for new UNKNOWN services, then wait again for them to complete
// Known limitations:
//   - if the method is called before the first "listNames()" call completes, this request will be blocked
//   - if libdbus is broken and doesn't report errors to timed out requests, then this request will always block for the default 2 seconds (waitTimeLimit)
//   - the method has to be called many times, if you actually want to wait for all services, otherwise you'll always get a partial response. I.e. the more you call this method, the hotter the internal cache gets.
std::vector<std::string> DBusServiceRegistry::getAvailableServiceInstances(const std::string& serviceName,
                                                                           const std::string& domainName) {
    std::vector<std::string> availableServiceInstances;

    if (!dbusDaemonProxy_->isAvailable()) {
        return availableServiceInstances;
    }

    std::chrono::milliseconds timeout(2000);
    std::unique_lock<std::mutex> dbusServicesLock(dbusServicesMutex_);

    if (!waitDBusServicesAvailable(dbusServicesLock, timeout)) {
        return availableServiceInstances;
    }

    while (timeout.count() > 0) {
        size_t dbusServiceResolvingCount = getAvailableServiceInstances(serviceName, availableServiceInstances);

        if (!dbusServiceResolvingCount) {
            break;
        }

        // wait for unknown and acquiring services, then restart from the beginning
        typedef std::chrono::high_resolution_clock clock;
        clock::time_point startTimePoint = clock::now();

        size_t wakeupCount = 0;
        dbusServiceChanged_.wait_for(
                        dbusServicesLock,
                        timeout,
                        [&] {
                            wakeupCount++;
                            return wakeupCount > dbusServiceResolvingCount;
                        });

        if (wakeupCount > 1) {
            getAvailableServiceInstances(serviceName, availableServiceInstances);
            break;
        }

        std::chrono::milliseconds elapsedWaitTime =
                        std::chrono::duration_cast<std::chrono::milliseconds>(clock::now() - startTimePoint);
        timeout -= elapsedWaitTime;
    }

    // maybe partial list but it contains everything we know for now
    return availableServiceInstances;
}

size_t DBusServiceRegistry::getAvailableServiceInstances(const std::string& dbusInterfaceName, std::vector<std::string>& availableServiceInstances) {
    size_t dbusServicesResolvingCount = 0;

    availableServiceInstances.clear();

    // caller must hold lock
    auto dbusServiceIterator = dbusServices_.begin();
    while (dbusServiceIterator != dbusServices_.end()) {
        const std::string& dbusServiceName = dbusServiceIterator->first;
        DBusServiceState& dbusServiceState = dbusServiceIterator->second.first;
        const DBusInstanceList& dbusInstanceList = dbusServiceIterator->second.second;

        // count the resolving services and start aclquiring the objects for unknown ones
        switch (dbusServiceState) {
            case DBusServiceState::AVAILABLE:
                resolveDBusServiceInstances(dbusServiceIterator);
                dbusServicesResolvingCount++;
                break;

            case DBusServiceState::RESOLVING:
            case DBusServiceState::RESOLVED:
                if (dbusServiceState == DBusServiceState::RESOLVING) {
                    dbusServicesResolvingCount++;
                }

                for (auto& dbusInstanceIterator : dbusInstanceList) {
                    const AvailabilityStatus& dbusInstanceAvailabilityStatus = dbusInstanceIterator.second.first;
                    const std::string& dbusInstanceObjectPath = dbusInstanceIterator.first.first;
                    const std::string& dbusInstanceInterfaceName = dbusInstanceIterator.first.second;

                    if (dbusInstanceAvailabilityStatus == AvailabilityStatus::AVAILABLE
                                    && dbusInstanceInterfaceName == dbusInterfaceName) {
                        std::string commonApiAddress;

                        DBusAddressTranslator::getInstance().searchForCommonAddress(
                                        dbusInterfaceName,
                                        dbusServiceName,
                                        dbusInstanceObjectPath,
                                        commonApiAddress);

                        availableServiceInstances.emplace_back(std::move(commonApiAddress));
                    }
                }
                break;
        }

        dbusServiceIterator++;
    }

    return dbusServicesResolvingCount;
}


DBusServiceRegistry::Subscription DBusServiceRegistry::subscribeAvailabilityListener(const std::string& commonApiAddress,
                                                                                     DBusServiceListener serviceListener) {
    std::string dbusInterfaceName;
    std::string dbusServiceName;
    std::string dbusObjectPath;

    DBusAddressTranslator::getInstance().searchForDBusAddress(commonApiAddress, dbusInterfaceName, dbusServiceName, dbusObjectPath);

    std::lock_guard<std::mutex> dbusServicesLock(dbusServicesMutex_);

    auto dbusServiceIterator = dbusServices_.find(dbusServiceName);

    // add service for the first time
    if (dbusServiceIterator == dbusServices_.end()) {
        DBusServiceState dbusServiceState = DBusServiceState::UNKNOWN;

        if (dbusServicesStatus_ == AvailabilityStatus::AVAILABLE) {
            dbusServiceState = DBusServiceState::NOT_AVAILABLE;
        }

        auto insertIterator = dbusServices_.insert({ dbusServiceName, { dbusServiceState, DBusInstanceList() } });
        assert(insertIterator.second);
        dbusServiceIterator = insertIterator.first;
    }

    DBusServiceState& dbusServiceState = dbusServiceIterator->second.first;
    DBusInstanceList& dbusInstanceList = dbusServiceIterator->second.second;

    auto dbusInstanceIterator = addDBusServiceInstance(
                    dbusInstanceList,
                    dbusObjectPath,
                    dbusInterfaceName);
    AvailabilityStatus& dbusInstanceAvailabilityStatus = dbusInstanceIterator->second.first;
    DBusServiceListenerList& dbusServiceListenerList = dbusInstanceIterator->second.second;

    if (dbusServiceState == DBusServiceState::RESOLVED
                    && dbusInstanceAvailabilityStatus == AvailabilityStatus::UNKNOWN) {
        dbusInstanceAvailabilityStatus = AvailabilityStatus::NOT_AVAILABLE;
    }

    Subscription listenerSubscription = dbusServiceListenerList.insert(
                    dbusServiceListenerList.end(), serviceListener);

    switch (dbusServiceState) {
        case DBusServiceState::AVAILABLE:
            resolveDBusServiceInstances(dbusServiceIterator);
            break;

        case DBusServiceState::RESOLVING:
            if (dbusInstanceAvailabilityStatus == AvailabilityStatus::AVAILABLE) {
                serviceListener(dbusInstanceAvailabilityStatus);
            }
            break;

        case DBusServiceState::RESOLVED:
        case DBusServiceState::NOT_AVAILABLE:
            serviceListener(dbusInstanceAvailabilityStatus);
            break;
    }

    return listenerSubscription;
}

void DBusServiceRegistry::unsubscribeAvailabilityListener(const std::string& commonApiAddress,
                                                          Subscription& listenerSubscription) {
    std::string dbusInterfaceName;
    std::string dbusServiceName;
    std::string dbusObjectPath;

    DBusAddressTranslator::getInstance().searchForDBusAddress(commonApiAddress, dbusInterfaceName, dbusServiceName, dbusObjectPath);

    std::lock_guard<std::mutex> dbusServicesLock(dbusServicesMutex_);
    auto dbusServiceIterator = dbusServices_.find(dbusServiceName);

    if (dbusServiceIterator == dbusServices_.end()) {
        return;
    }

    DBusServiceState& dbusServiceState = dbusServiceIterator->second.first;
    DBusInstanceList& dbusInstanceList = dbusServiceIterator->second.second;

    auto dbusInstanceIterator = dbusInstanceList.find({ dbusObjectPath, dbusInterfaceName });
    if (dbusInstanceIterator == dbusInstanceList.end()) {
        return;
    }

    const AvailabilityStatus& dbusServiceAvailabilityStatus = dbusInstanceIterator->second.first;
    DBusServiceListenerList& dbusServiceListenerList = dbusInstanceIterator->second.second;

    dbusServiceListenerList.erase(listenerSubscription);

    if (dbusServiceListenerList.empty() && dbusServiceAvailabilityStatus != AvailabilityStatus::AVAILABLE) {
        dbusInstanceList.erase(dbusInstanceIterator);

        if (dbusInstanceList.empty() && dbusServiceState == DBusServiceState::UNKNOWN) {
            dbusServices_.erase(dbusServiceIterator);
        }
    }
}

SubscriptionStatus DBusServiceRegistry::onDBusDaemonProxyStatusEvent(const AvailabilityStatus& availabilityStatus) {
    std::unique_lock<std::mutex> dbusServicesLock(dbusServicesMutex_);

    switch (availabilityStatus) {
        case AvailabilityStatus::AVAILABLE:
            dbusServicesStatus_ = AvailabilityStatus::UNKNOWN;
            dbusDaemonProxy_->listNamesAsync(std::bind(
                            &DBusServiceRegistry::onListNamesCallback,
                            this,
                            std::placeholders::_1,
                            std::placeholders::_2));
            break;

        case AvailabilityStatus::NOT_AVAILABLE:
            auto dbusServiceIterator = dbusServices_.begin();

            while (dbusServiceIterator != dbusServices_.end()) {
                dbusServiceIterator = onDBusServiceOffline(dbusServiceIterator, DBusServiceState::NOT_AVAILABLE);
            }

            dbusServicesStatus_ = AvailabilityStatus::NOT_AVAILABLE;
            break;
    }

    return SubscriptionStatus::RETAIN;
}

SubscriptionStatus DBusServiceRegistry::onDBusDaemonProxyNameOwnerChangedEvent(const std::string& affectedName,
                                                                               const std::string& oldOwner,
                                                                               const std::string& newOwner) {
    if (isDBusServiceName(affectedName)) {
        AvailabilityStatus dbusServiceAvailabilityStatus = AvailabilityStatus::AVAILABLE;

        if (newOwner.empty()) {
            dbusServiceAvailabilityStatus = AvailabilityStatus::NOT_AVAILABLE;
        }

        std::unique_lock<std::mutex> dbusServicesLock(dbusServicesMutex_);

        onDBusServiceAvailabilityStatus(affectedName, dbusServiceAvailabilityStatus);
    }

    return SubscriptionStatus::RETAIN;
}

void DBusServiceRegistry::onListNamesCallback(const CommonAPI::CallStatus& callStatus, std::vector<std::string> dbusNames) {
    std::unique_lock<std::mutex> dbusServicesLock(dbusServicesMutex_);

    if (callStatus == CallStatus::SUCCESS) {
        for (const std::string& dbusName : dbusNames) {
            if (isDBusServiceName(dbusName)) {
                onDBusServiceAvailabilityStatus(dbusName, AvailabilityStatus::AVAILABLE);
            }
        }
    }

    dbusServicesStatus_ = AvailabilityStatus::AVAILABLE;

    auto dbusServiceIterator = dbusServices_.begin();
    while (dbusServiceIterator != dbusServices_.end()) {
        const DBusServiceState& dbusServiceState = dbusServiceIterator->second.first;

        if (dbusServiceState == DBusServiceState::UNKNOWN) {
            dbusServiceIterator = onDBusServiceOffline(dbusServiceIterator, DBusServiceState::NOT_AVAILABLE);
        } else {
            dbusServiceIterator++;
        }
    }
}

void DBusServiceRegistry::onDBusServiceAvailabilityStatus(const std::string& dbusServiceName, const AvailabilityStatus& availabilityStatus) {
    auto dbusServiceIterator = dbusServices_.find(dbusServiceName);

    if (dbusServiceIterator != dbusServices_.end()) {
        onDBusServiceAvailabilityStatus(dbusServiceIterator, availabilityStatus);

    } else if (availabilityStatus == AvailabilityStatus::AVAILABLE) {
        dbusServices_.insert({ dbusServiceName, { DBusServiceState::AVAILABLE, DBusInstanceList() } });
        dbusServiceChanged_.notify_all();
    }
}

DBusServiceRegistry::DBusServiceList::iterator DBusServiceRegistry::onDBusServiceAvailabilityStatus(DBusServiceList::iterator& dbusServiceIterator,
                                                                                                    const AvailabilityStatus& availabilityStatus) {
    DBusServiceState& dbusServiceState = dbusServiceIterator->second.first;
    DBusInstanceList& dbusInstanceList = dbusServiceIterator->second.second;

    if (availabilityStatus == AvailabilityStatus::AVAILABLE) {
        const std::string& dbusServiceName = dbusServiceIterator->first;

        if (dbusServiceState != DBusServiceState::RESOLVING) {
            resolveDBusServiceInstances(dbusServiceIterator);
        }

        return dbusServiceIterator;
    }

    dbusServiceState = (availabilityStatus == AvailabilityStatus::UNKNOWN) ?
                    DBusServiceState::UNKNOWN :
                    DBusServiceState::NOT_AVAILABLE;

    return onDBusServiceOffline(dbusServiceIterator, dbusServiceState);
}

DBusServiceRegistry::DBusServiceList::iterator DBusServiceRegistry::onDBusServiceOffline(DBusServiceList::iterator& dbusServiceIterator,
                                                                                         const DBusServiceState& newDBusServiceState) {
    DBusServiceState& dbusServiceState = dbusServiceIterator->second.first;
    DBusInstanceList& dbusInstanceList = dbusServiceIterator->second.second;
    auto dbusInstanceIterator = dbusInstanceList.begin();

    assert(newDBusServiceState == DBusServiceState::UNKNOWN || newDBusServiceState == DBusServiceState::NOT_AVAILABLE);

    dbusServiceState = newDBusServiceState;

    while (dbusInstanceIterator != dbusInstanceList.end()) {
        AvailabilityStatus& dbusInstanceAvailabilityStatus = dbusInstanceIterator->second.first;
        DBusServiceListenerList& dbusServiceListenerList = dbusInstanceIterator->second.second;

        // notify listeners
        if (!dbusServiceListenerList.empty()) {
            // the internal state is unknown until the next time we ask the object manager
            notifyDBusServiceListeners(dbusServiceListenerList, AvailabilityStatus::NOT_AVAILABLE);
            dbusInstanceAvailabilityStatus = AvailabilityStatus::UNKNOWN;
            dbusInstanceIterator++;
        } else {
            dbusInstanceIterator = dbusInstanceList.erase(dbusInstanceIterator);
        }
    }

    dbusServiceChanged_.notify_all();

    if (dbusInstanceList.empty()) {
        return dbusServices_.erase(dbusServiceIterator);
    }

    dbusServiceIterator++;

    return dbusServiceIterator;
}

void DBusServiceRegistry::resolveDBusServiceInstances(DBusServiceList::iterator& dbusServiceIterator) {
    const std::string& dbusServiceName = dbusServiceIterator->first;
    DBusServiceState& dbusServiceState = dbusServiceIterator->second.first;
    DBusInstanceList& dbusInstanceList = dbusServiceIterator->second.second;
    std::vector<DBusServiceAddress> predefinedDBusServiceInstances;

    dbusServiceState = DBusServiceState::RESOLVING;

    // add predefined instances
    DBusAddressTranslator::getInstance().getPredefinedInstances(dbusServiceName, predefinedDBusServiceInstances);

    for (auto& dbusServiceAddress : predefinedDBusServiceInstances) {
        const std::string& dbusObjectPath = std::get<1>(dbusServiceAddress);
        const std::string& dbusInterfaceName = std::get<2>(dbusServiceAddress);

        onDBusServiceInstanceAvailable(dbusInstanceList, dbusObjectPath, dbusInterfaceName);
    }

    dbusServiceChanged_.notify_all();

    // search for remote instances
    DBusDaemonProxy::GetManagedObjectsAsyncCallback callback = std::bind(&DBusServiceRegistry::onGetManagedObjectsCallback,
                                                                         this,
                                                                         std::placeholders::_1,
                                                                         std::placeholders::_2,
                                                                         dbusServiceName);
    dbusDaemonProxy_->getManagedObjectsAsync(dbusServiceName, callback);
}

void DBusServiceRegistry::onGetManagedObjectsCallback(const CallStatus& callStatus,
                                                      DBusDaemonProxy::DBusObjectToInterfaceDict managedObjects,
                                                      const std::string& dbusServiceName) {
    std::unique_lock<std::mutex> dbusServicesLock(dbusServicesMutex_);

    // already offline
    if (dbusServicesStatus_ == AvailabilityStatus::NOT_AVAILABLE) {
        return;
    }

    auto dbusServiceIterator = dbusServices_.find(dbusServiceName);
    if (dbusServiceIterator == dbusServices_.end()) {
        return; // nothing we can do
    }

    DBusServiceState& dbusServiceState = dbusServiceIterator->second.first;
    DBusInstanceList& dbusInstanceList = dbusServiceIterator->second.second;

    dbusServiceState = DBusServiceState::RESOLVED;

    if (callStatus == CallStatus::SUCCESS) {
        for (auto& dbusObjectPathIterator : managedObjects) {
            const std::string& dbusObjectPath = dbusObjectPathIterator.first;

            for (auto& dbusInterfaceNameIterator : dbusObjectPathIterator.second) {
                const std::string& dbusInterfaceName = dbusInterfaceNameIterator.first;

                onDBusServiceInstanceAvailable(dbusInstanceList, dbusObjectPath, dbusInterfaceName);
            }
        }
    }

    dbusServiceChanged_.notify_all();

    // notify only UNKNOWN. The predefined and resolved have already been handled
    for (auto& dbusInstanceIterator : dbusInstanceList) {
        AvailabilityStatus& dbusInstanceAvailabilityStatus = dbusInstanceIterator.second.first;
        DBusServiceListenerList& dbusServiceListenerList = dbusInstanceIterator.second.second;

        if (dbusInstanceAvailabilityStatus == AvailabilityStatus::UNKNOWN) {
            dbusInstanceAvailabilityStatus = AvailabilityStatus::NOT_AVAILABLE;
            notifyDBusServiceListeners(dbusServiceListenerList, dbusInstanceAvailabilityStatus);
        }
    }
}

void DBusServiceRegistry::onDBusServiceInstanceAvailable(DBusInstanceList& dbusInstanceList,
                                                         const std::string& dbusObjectPath,
                                                         const std::string& dbusInterfaceName) {
    auto dbusInstanceIterator = addDBusServiceInstance(dbusInstanceList, dbusObjectPath, dbusInterfaceName);
    AvailabilityStatus& dbusInstanceAvailabilityStatus = dbusInstanceIterator->second.first;
    DBusServiceListenerList& dbusServiceListenerList = dbusInstanceIterator->second.second;

    dbusInstanceAvailabilityStatus = AvailabilityStatus::AVAILABLE;

    notifyDBusServiceListeners(dbusServiceListenerList, dbusInstanceAvailabilityStatus);
}

DBusServiceRegistry::DBusInstanceList::iterator DBusServiceRegistry::addDBusServiceInstance(DBusInstanceList& dbusInstanceList,
                                                                                            const std::string& dbusObjectPath,
                                                                                            const std::string& dbusInterfaceName) {
    auto dbusInstanceIterator = dbusInstanceList.find({ dbusObjectPath, dbusInterfaceName });

    // add instance for the first time
    if (dbusInstanceIterator == dbusInstanceList.end()) {
       auto insertIterator = dbusInstanceList.insert(
                        { { dbusObjectPath, dbusInterfaceName }, { AvailabilityStatus::UNKNOWN, DBusServiceListenerList() } });
       const bool& insertSuccessfull = insertIterator.second;

       assert(insertSuccessfull);
       dbusInstanceIterator = insertIterator.first;
    }

    return dbusInstanceIterator;
}

void DBusServiceRegistry::notifyDBusServiceListeners(DBusServiceListenerList& dbusServiceListenerList,
                                                     const AvailabilityStatus& availabilityStatus) {
    for (auto& dbusServiceListener : dbusServiceListenerList) {
        dbusServiceListener(availabilityStatus);
    }
}

bool DBusServiceRegistry::isDBusServiceName(const std::string& name) {
    return name[0] != ':';
}

}// namespace DBus
}// namespace CommonAPI