service_builder_event.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_EVENT_BUILDER_HPP
#define IOX2_SERVICE_EVENT_BUILDER_HPP
 
#include "iox2/attribute_specifier.hpp"
#include "iox2/attribute_verifier.hpp"
#include "iox2/bb/detail/builder.hpp"
#include "iox2/bb/expected.hpp"
#include "iox2/bb/optional.hpp"
#include "iox2/event_id.hpp"
#include "iox2/internal/iceoryx2.hpp"
#include "iox2/port_factory_event.hpp"
#include "iox2/service_builder_event_error.hpp"
#include "iox2/service_type.hpp"
 
#include <cstdint>
 
namespace iox2 {
template <ServiceType S>
class ServiceBuilderEvent {
  public:
#ifdef DOXYGEN_MACRO_FIX
    auto max_nodes(const uint64_t value) -> decltype(auto);
#else
    IOX2_BUILDER_OPTIONAL(uint64_t, max_nodes);
#endif
 
#ifdef DOXYGEN_MACRO_FIX
    auto event_id_max_value(const uint64_t value) -> decltype(auto);
#else
    IOX2_BUILDER_OPTIONAL(uint64_t, event_id_max_value);
#endif
 
#ifdef DOXYGEN_MACRO_FIX
    auto max_notifiers(const uint64_t value) -> decltype(auto);
#else
    IOX2_BUILDER_OPTIONAL(uint64_t, max_notifiers);
#endif
 
#ifdef DOXYGEN_MACRO_FIX
    auto max_listeners(const uint64_t value) -> decltype(auto);
#else
    IOX2_BUILDER_OPTIONAL(uint64_t, max_listeners);
#endif
 
  public:
    auto notifier_dropped_event(EventId event_id) && -> ServiceBuilderEvent&&;
 
    auto notifier_created_event(EventId event_id) && -> ServiceBuilderEvent&&;
 
    auto notifier_dead_event(EventId event_id) && -> ServiceBuilderEvent&&;
 
    auto deadline(iox2::bb::Duration deadline) && -> ServiceBuilderEvent&&;
 
    auto disable_notifier_dropped_event() && -> ServiceBuilderEvent&&;
 
    auto disable_notifier_created_event() && -> ServiceBuilderEvent&&;
 
    auto disable_notifier_dead_event() && -> ServiceBuilderEvent&&;
 
    auto disable_deadline() && -> ServiceBuilderEvent&&;
 
    auto open_or_create() && -> bb::Expected<PortFactoryEvent<S>, EventOpenOrCreateError>;
 
    auto open_or_create_with_attributes(
        const AttributeVerifier& required_attributes) && -> bb::Expected<PortFactoryEvent<S>, EventOpenOrCreateError>;
 
    auto open() && -> bb::Expected<PortFactoryEvent<S>, EventOpenError>;
 
    auto open_with_attributes(
        const AttributeVerifier& required_attributes) && -> bb::Expected<PortFactoryEvent<S>, EventOpenError>;
 
    auto create() && -> bb::Expected<PortFactoryEvent<S>, EventCreateError>;
 
    auto create_with_attributes(
        const AttributeSpecifier& attributes) && -> bb::Expected<PortFactoryEvent<S>, EventCreateError>;
 
  private:
    template <ServiceType>
    friend class ServiceBuilder;
 
    explicit ServiceBuilderEvent(iox2_service_builder_h handle);
 
    void set_parameters();
 
    iox2_service_builder_event_h m_handle = nullptr;
 
    bb::Optional<EventId> m_notifier_dead_event;
    bb::Optional<EventId> m_notifier_created_event;
    bb::Optional<EventId> m_notifier_dropped_event;
    bb::Optional<bb::Duration> m_deadline;
    bool m_verify_notifier_dead_event = false;
    bool m_verify_notifier_created_event = false;
    bool m_verify_notifier_dropped_event = false;
    bool m_verify_deadline = false;
};
} // namespace iox2
 
#endif