service.hpp

Go to the documentation of this file.

// Copyright (c) 2024 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the
// terms of the Apache Software License 2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
// which is available at https://opensource.org/licenses/MIT.
//
// SPDX-License-Identifier: Apache-2.0 OR MIT
 
#ifndef IOX2_SERVICE_HPP
#define IOX2_SERVICE_HPP
 
#include "iox2/bb/expected.hpp"
#include "iox2/bb/optional.hpp"
#include "iox2/bb/static_function.hpp"
#include "iox2/callback_progression.hpp"
#include "iox2/config.hpp"
#include "iox2/messaging_pattern.hpp"
#include "iox2/service_details.hpp"
#include "iox2/service_error_enums.hpp"
#include "iox2/service_name.hpp"
#include "iox2/service_type.hpp"
 
namespace iox2 {
template <ServiceType S>
class Service {
  public:
    static auto does_exist(const ServiceName& service_name, ConfigView config, MessagingPattern messaging_pattern)
        -> bb::Expected<bool, ServiceDetailsError>;
 
    static auto details(const ServiceName& service_name, ConfigView config, MessagingPattern messaging_pattern)
        -> bb::Expected<bb::Optional<ServiceDetails<S>>, ServiceDetailsError>;
 
    static auto list(ConfigView config,
                     const iox2::bb::StaticFunction<CallbackProgression(ServiceDetails<S>)>& callback)
        -> bb::Expected<void, ServiceListError>;
};
} // namespace iox2
 
#endif