File: discovery_monitor.hpp

package info (click to toggle)
iceoryx 2.0.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 11,260 kB
  • sloc: cpp: 94,127; ansic: 1,443; sh: 1,436; python: 1,377; xml: 80; makefile: 61
file content (97 lines) | stat: -rw-r--r-- 3,427 bytes parent folder | download | duplicates (3)
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
// Copyright (c) 2022 by Apex.AI Inc. All rights reserved.
//
// Licensed 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.
//
// SPDX-License-Identifier: Apache-2.0

#pragma once

#include "iceoryx_posh/popo/listener.hpp"
#include "iceoryx_posh/runtime/service_discovery.hpp"

#include "iceoryx_hoofs/cxx/function.hpp"
#include "iceoryx_hoofs/cxx/optional.hpp"

#include <vector>

namespace discovery
{
using ServiceDiscovery = iox::runtime::ServiceDiscovery;
using ServiceContainer = std::vector<iox::capro::ServiceDescription>;

ServiceDiscovery& serviceDiscovery();

/// @brief User defined discovery with monitoring functionality that allows
/// to execute a callback in a background thread whenever the discovery changes.
class Discovery
{
  public:
    Discovery();

    /// @brief register a callback to be executed on any service discovery change
    /// @param callback callback with signature void(ServiceDiscovery& discovery)
    /// @note callback is executed in a background thread
    /// @todo signature of callback is due to the listener signature requirement
    ///       but we could hide this from the user (by e.g. accessing ServiceRegistry via singleton
    ///       and passing it)
    template <typename Callback>
    bool registerCallback(const Callback& callback);

    /// @brief deregister the active callback (if any)
    void deregisterCallback();

    /// @brief get all services matching a findService query
    /// @note invokes findService of the native iceoryx ServiceDiscovery API
    ServiceContainer findService(const iox::cxx::optional<iox::capro::IdString_t>& service,
                                 const iox::cxx::optional<iox::capro::IdString_t>& instance,
                                 const iox::cxx::optional<iox::capro::IdString_t>& event);

  private:
    using callback_t = iox::cxx::function<void(Discovery&)>;

    ServiceDiscovery* m_discovery{nullptr};
    iox::popo::Listener m_listener;

    /// @note currently only one callback can be active (and there is no need to have more
    /// as we only have one event at the ServiceDiscovery to attach to - SERVICE_REGISTRY_CHANGED)
    callback_t m_callback;

    static void invokeCallback(ServiceDiscovery* discovery, Discovery* self);
};

//! [registerCallback]
template <typename Callback>
bool Discovery::registerCallback(const Callback& callback)
//! [registerCallback]
{
    if (m_callback)
    {
        return false;
    }

    m_callback = callback;
    auto errorHandler = [](auto) {
        std::cerr << "failed to attach to listener" << std::endl;
        std::exit(EXIT_FAILURE);
    };

    //! [attach listener]
    auto invoker = iox::popo::createNotificationCallback(invokeCallback, *this);
    m_listener.attachEvent(*m_discovery, iox::runtime::ServiceDiscoveryEvent::SERVICE_REGISTRY_CHANGED, invoker)
        .or_else(errorHandler);
    //! [attach listener]

    return true;
}

} // namespace discovery