notifier.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_NOTIFIER_HPP
#define IOX2_NOTIFIER_HPP
 
#include "iox2/bb/duration.hpp"
#include "iox2/bb/expected.hpp"
#include "iox2/bb/optional.hpp"
#include "iox2/event_id.hpp"
#include "iox2/internal/iceoryx2.hpp"
#include "iox2/notifier_error.hpp"
#include "iox2/port_name.hpp"
#include "iox2/service_type.hpp"
#include "iox2/unique_port_id.hpp"
 
namespace iox2 {
template <ServiceType S>
class Notifier {
  public:
    Notifier(Notifier&&) noexcept;
    auto operator=(Notifier&&) noexcept -> Notifier&;
    ~Notifier();
 
    Notifier(const Notifier&) = delete;
    auto operator=(const Notifier&) -> Notifier& = delete;
 
    auto id() const -> UniqueNotifierId;
 
    auto name() const -> PortNameView;
 
    auto notify() const -> bb::Expected<size_t, NotifierNotifyError>;
 
    auto notify_with_custom_event_id(EventId event_id) const -> bb::Expected<size_t, NotifierNotifyError>;
 
    auto deadline() const -> bb::Optional<iox2::bb::Duration>;
 
  private:
    template <ServiceType>
    friend class PortFactoryNotifier;
 
    explicit Notifier(iox2_notifier_h handle);
    void drop();
 
    iox2_notifier_h m_handle = nullptr;
};
} // namespace iox2
 
#endif