Program Listing for File registration.h

↰ Return to documentation for file (ecal/core/include/ecal/registration.h)

/* ========================= eCAL LICENSE =================================
 *
 * Copyright (C) 2016 - 2025 Continental Corporation
 *
 * 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.
 *
 * ========================= eCAL LICENSE =================================
*/

#pragma once

#include <ecal/os.h>
#include <ecal/pubsub/types.h>
#include <ecal/service/types.h>

#include <cstdint>
#include <functional>
#include <map>
#include <set>
#include <string>
#include <vector>

namespace eCAL
{
  namespace Registration
  {
    struct SServiceMethod
    {
      std::string service_name;
      std::string method_name;

      bool operator<(const SServiceMethod& other) const
      {
        return std::tie(service_name, method_name) < std::tie(other.service_name, other.method_name);
      }
    };

    using CallbackToken = std::size_t;

    enum class RegistrationEventType
    {
      new_entity,
      deleted_entity
    };

    /* @brief Event callback, when a topic related entity (publisher / subscriber) has been created or deleted */
    using TopicEventCallbackT = std::function<void(const STopicId&, RegistrationEventType)>;

    ECAL_API bool GetPublisherIDs(std::set<STopicId>& topic_ids_);

    ECAL_API bool GetPublisherInfo(const STopicId& id_, SDataTypeInformation& topic_info_);

    ECAL_API CallbackToken AddPublisherEventCallback(const TopicEventCallbackT& callback_);

    ECAL_API void RemPublisherEventCallback(CallbackToken token_);

    ECAL_API bool GetSubscriberIDs(std::set<STopicId>& topic_ids_);

    ECAL_API bool GetSubscriberInfo(const STopicId& id_, SDataTypeInformation& topic_info_);

    ECAL_API CallbackToken AddSubscriberEventCallback(const TopicEventCallbackT& callback_);

    ECAL_API void RemSubscriberEventCallback(CallbackToken token_);

    ECAL_API bool GetServerIDs(std::set<SServiceId>& service_ids_);

    ECAL_API bool GetServerInfo(const SServiceId& id_, ServiceMethodInformationSetT& service_method_info_);

    ECAL_API bool GetClientIDs(std::set<SServiceId>& service_ids_);

    ECAL_API bool GetClientInfo(const SServiceId& id_, ServiceMethodInformationSetT& service_method_info_);

    ECAL_API bool GetPublishedTopicNames(std::set<std::string>& topic_names_);

    ECAL_API bool GetSubscribedTopicNames(std::set<std::string>& topic_names_);

    ECAL_API bool GetServerMethodNames(std::set<SServiceMethod>& server_method_names_);

    ECAL_API bool GetClientMethodNames(std::set<SServiceMethod>& client_method_names_);
  }
}