serviceRegistryIf.hpp

Go to the documentation of this file.

 
#ifndef RTCTK_COMPONENTFRAMEWORK_SERVICEREGISTRYIF_HPP
#define RTCTK_COMPONENTFRAMEWORK_SERVICEREGISTRYIF_HPP
 
#include <memory>
#include <string>
 
#include <mal/Cii.hpp>
 
#include <rtctk/componentFramework/exceptions.hpp>
 
namespace rtctk::componentFramework {

class ServiceRegistryIf {
public:
    using AdapterIdType = elt::mal::Uri;
 
    using ServiceEndpoint = elt::mal::Uri;

    static const std::string REQ_REP_ENDPOINT;

    static const std::string PUB_SUB_ENDPOINT;

    static const std::string COMPONENT_TYPE;
 
    class InvalidComponent : public RtctkException {
    public:
        explicit InvalidComponent(const std::string& component, const std::string& service);
        explicit InvalidComponent(const std::string& component,
                                  const std::string& service,
                                  const std::string& reason);
    };
    class InvalidService : public RtctkException {
    public:
        explicit InvalidService(const std::string& service);
        explicit InvalidService(const std::string& service, const std::string& reason);
    };
    class ConsulUnavailable : public RtctkException {
    public:
        explicit ConsulUnavailable(const std::string& message, const std::string& service);
    };

    virtual ~ServiceRegistryIf() = default;

    virtual std::vector<std::string>
    ListComponents(const std::string& service_type = COMPONENT_TYPE) = 0;

    virtual ServiceEndpoint GetOldbEndpoint() = 0;
    virtual ServiceEndpoint GetRuntimeRepoEndpoint() = 0;
    virtual ServiceEndpoint GetPersistentRepoEndpoint() = 0;
    virtual ServiceEndpoint GetTelegrafEndpoint() = 0;

    virtual ServiceEndpoint Get(const std::string& comp_name,
                                const std::string& service_name,
                                const std::string& service_type = COMPONENT_TYPE,
                                const bool health_check = true) = 0;

    static std::unique_ptr<ServiceRegistryIf> CreateAdapter(const elt::mal::Uri& uri);
};
 
}  // namespace rtctk::componentFramework
 
#endif  // RTCTK_COMPONENTFRAMEWORK_SERVICEREGISTRYIF_HPP