ravenna_browser.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: AGPL-3.0-or-later
/*
 * Project: RAVENNAKIT (RAVENNA / AES67 / ST2110-30 SDK)
 * Copyright (c) 2024-2025 Sound on Digital
 *
 * This file is part of RAVENNAKIT.
 *
 * RAVENNAKIT is dual-licensed:
 *   1) Under the terms of the GNU Affero General Public License as published by
 *      the Free Software Foundation, either version 3 of the License, or
 *      (at your option) any later version (the "AGPL License"); and
 *   2) Under a commercial license from Sound on Digital, for customers who
 *      cannot (or do not wish to) comply with the AGPL License terms.
 *
 * If you obtained this file under the AGPL License, you may redistribute it
 * and/or modify it under the terms of the AGPL License. See the LICENSE
 * file in the project root for details.
 *
 * For commercial licensing, support, and other inquiries, please visit:
 *
 *     https://ravennakit.com
 *
 */
 
#pragma once
 
#include "ravennakit/core/util/subscriber_list.hpp"
#include "ravennakit/dnssd/dnssd_browser.hpp"
#include "ravennakit/core/expected.hpp"
 
namespace rav {

class RavennaBrowser {
  public:
    class Subscriber {
      public:
        virtual ~Subscriber() = default;

        virtual void ravenna_node_discovered([[maybe_unused]] const dnssd::ServiceDescription& desc) {}

        virtual void ravenna_node_removed([[maybe_unused]] const dnssd::ServiceDescription& desc) {}

        virtual void ravenna_session_discovered([[maybe_unused]] const dnssd::ServiceDescription& desc) {}

        virtual void ravenna_session_removed([[maybe_unused]] const dnssd::ServiceDescription& desc) {}
    };
 
    explicit RavennaBrowser(boost::asio::io_context& io_context);

    [[nodiscard]] const dnssd::ServiceDescription* find_session(const std::string& session_name) const;

    [[nodiscard]] const dnssd::ServiceDescription* find_node(const std::string& node_name) const;

    [[nodiscard]] bool subscribe(Subscriber* subscriber_to_add);

    [[nodiscard]] bool unsubscribe(const Subscriber* subscriber_to_remove);

    tl::expected<void, const char*> set_node_browsing_enabled(bool enabled);

    tl::expected<void, const char*> set_session_browsing_enabled(bool enabled);
 
  private:
    boost::asio::io_context& io_context_;
    std::unique_ptr<dnssd::Browser> node_browser_;
    std::unique_ptr<dnssd::Browser> session_browser_;
 
    SubscriberList<Subscriber> subscribers_;
};
 
}  // namespace rav