unique_port_id.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_UNIQUE_PORT_ID_HPP
#define IOX2_UNIQUE_PORT_ID_HPP
 
#include "iox2/bb/optional.hpp"
#include "iox2/bb/static_vector.hpp"
#include "iox2/internal/iceoryx2.hpp"
 
namespace iox2 {
 
constexpr uint64_t UNIQUE_PORT_ID_LENGTH = 16;
using RawIdType = iox2::bb::StaticVector<uint8_t, UNIQUE_PORT_ID_LENGTH>;
 
class UniquePublisherId {
  public:
    UniquePublisherId(const UniquePublisherId&) = delete;
    UniquePublisherId(UniquePublisherId&& rhs) noexcept;
    auto operator=(const UniquePublisherId& rhs) -> UniquePublisherId& = delete;
    auto operator=(UniquePublisherId&& rhs) noexcept -> UniquePublisherId&;
    ~UniquePublisherId();
 
    auto bytes() const -> const bb::Optional<RawIdType>&;
 
  private:
    template <ServiceType, typename, typename>
    friend class Publisher;
    friend class HeaderPublishSubscribe;
    friend class PublisherDetailsView;
    friend auto operator==(const UniquePublisherId&, const UniquePublisherId&) -> bool;
    friend auto operator<(const UniquePublisherId&, const UniquePublisherId&) -> bool;
 
    explicit UniquePublisherId(iox2_unique_publisher_id_h handle);
    void drop();
 
    iox2_unique_publisher_id_h m_handle = nullptr;
    mutable bb::Optional<RawIdType> m_raw_id;
};
 
class UniqueSubscriberId {
  public:
    UniqueSubscriberId(const UniqueSubscriberId&) = delete;
    UniqueSubscriberId(UniqueSubscriberId&& rhs) noexcept;
    auto operator=(const UniqueSubscriberId& rhs) -> UniqueSubscriberId& = delete;
    auto operator=(UniqueSubscriberId&& rhs) noexcept -> UniqueSubscriberId&;
    ~UniqueSubscriberId();
 
    auto bytes() const -> const bb::Optional<RawIdType>&;
 
  private:
    template <ServiceType, typename, typename>
    friend class Subscriber;
    friend auto operator==(const UniqueSubscriberId&, const UniqueSubscriberId&) -> bool;
    friend auto operator<(const UniqueSubscriberId&, const UniqueSubscriberId&) -> bool;
    friend class SubscriberDetailsView;
 
    explicit UniqueSubscriberId(iox2_unique_subscriber_id_h handle);
    void drop();
 
    iox2_unique_subscriber_id_h m_handle = nullptr;
    mutable bb::Optional<RawIdType> m_raw_id;
};
 
class UniqueNotifierId {
  public:
    UniqueNotifierId(const UniqueNotifierId&) = delete;
    UniqueNotifierId(UniqueNotifierId&& rhs) noexcept;
    auto operator=(const UniqueNotifierId& rhs) -> UniqueNotifierId& = delete;
    auto operator=(UniqueNotifierId&& rhs) noexcept -> UniqueNotifierId&;
    ~UniqueNotifierId();
 
    auto bytes() const -> const bb::Optional<RawIdType>&;
 
  private:
    template <ServiceType>
    friend class Notifier;
    friend auto operator==(const UniqueNotifierId&, const UniqueNotifierId&) -> bool;
    friend auto operator<(const UniqueNotifierId&, const UniqueNotifierId&) -> bool;
    friend class NotifierDetailsView;
 
    explicit UniqueNotifierId(iox2_unique_notifier_id_h handle);
    void drop();
 
    iox2_unique_notifier_id_h m_handle = nullptr;
    mutable bb::Optional<RawIdType> m_raw_id;
};
 
class UniqueListenerId {
  public:
    UniqueListenerId(const UniqueListenerId&) = delete;
    UniqueListenerId(UniqueListenerId&& rhs) noexcept;
    auto operator=(const UniqueListenerId& rhs) -> UniqueListenerId& = delete;
    auto operator=(UniqueListenerId&& rhs) noexcept -> UniqueListenerId&;
    ~UniqueListenerId();
 
    auto bytes() const -> const bb::Optional<RawIdType>&;
 
  private:
    template <ServiceType>
    friend class Listener;
    friend auto operator==(const UniqueListenerId&, const UniqueListenerId&) -> bool;
    friend auto operator<(const UniqueListenerId&, const UniqueListenerId&) -> bool;
    friend class ListenerDetailsView;
 
    explicit UniqueListenerId(iox2_unique_listener_id_h handle);
    void drop();
 
    iox2_unique_listener_id_h m_handle = nullptr;
    mutable bb::Optional<RawIdType> m_raw_id;
};
 
class UniqueClientId {
  public:
    UniqueClientId(const UniqueClientId&) = delete;
    UniqueClientId(UniqueClientId&& rhs) noexcept;
    auto operator=(const UniqueClientId& rhs) -> UniqueClientId& = delete;
    auto operator=(UniqueClientId&& rhs) noexcept -> UniqueClientId&;
    ~UniqueClientId();
 
    auto bytes() const -> const bb::Optional<RawIdType>&;
 
  private:
    template <ServiceType, typename, typename, typename, typename>
    friend class Client;
    friend class RequestHeader;
    friend auto operator==(const UniqueClientId&, const UniqueClientId&) -> bool;
    friend auto operator<(const UniqueClientId&, const UniqueClientId&) -> bool;
    friend class ClientDetailsView;
 
    explicit UniqueClientId(iox2_unique_client_id_h handle);
    void drop();
 
    iox2_unique_client_id_h m_handle = nullptr;
    mutable bb::Optional<RawIdType> m_raw_id;
};
 
class UniqueServerId {
  public:
    UniqueServerId(const UniqueServerId&) = delete;
    UniqueServerId(UniqueServerId&& rhs) noexcept;
    auto operator=(const UniqueServerId& rhs) -> UniqueServerId& = delete;
    auto operator=(UniqueServerId&& rhs) noexcept -> UniqueServerId&;
    ~UniqueServerId();
 
    auto bytes() const -> const bb::Optional<RawIdType>&;
 
  private:
    template <ServiceType, typename, typename, typename, typename>
    friend class Server;
    friend class ResponseHeader;
    friend auto operator==(const UniqueServerId&, const UniqueServerId&) -> bool;
    friend auto operator<(const UniqueServerId&, const UniqueServerId&) -> bool;
    friend class ServerDetailsView;
 
    explicit UniqueServerId(iox2_unique_server_id_h handle);
    void drop();
 
    iox2_unique_server_id_h m_handle = nullptr;
    mutable bb::Optional<RawIdType> m_raw_id;
};
 
class UniqueReaderId {
  public:
    UniqueReaderId(const UniqueReaderId&) = delete;
    UniqueReaderId(UniqueReaderId&& rhs) noexcept;
    auto operator=(const UniqueReaderId& rhs) -> UniqueReaderId& = delete;
    auto operator=(UniqueReaderId&& rhs) noexcept -> UniqueReaderId&;
    ~UniqueReaderId();
 
    auto bytes() const -> const bb::Optional<RawIdType>&;
 
  private:
    template <ServiceType, typename>
    friend class Reader;
    friend auto operator==(const UniqueReaderId&, const UniqueReaderId&) -> bool;
    friend auto operator<(const UniqueReaderId&, const UniqueReaderId&) -> bool;
    friend class ReaderDetailsView;
 
    explicit UniqueReaderId(iox2_unique_reader_id_h handle);
    void drop();
 
    iox2_unique_reader_id_h m_handle = nullptr;
    mutable bb::Optional<RawIdType> m_raw_id;
};
 
class UniqueWriterId {
  public:
    UniqueWriterId(const UniqueWriterId&) = delete;
    UniqueWriterId(UniqueWriterId&& rhs) noexcept;
    auto operator=(const UniqueWriterId& rhs) -> UniqueWriterId& = delete;
    auto operator=(UniqueWriterId&& rhs) noexcept -> UniqueWriterId&;
    ~UniqueWriterId();
 
    auto bytes() const -> const bb::Optional<RawIdType>&;
 
  private:
    template <ServiceType, typename>
    friend class Writer;
    friend auto operator==(const UniqueWriterId&, const UniqueWriterId&) -> bool;
    friend auto operator<(const UniqueWriterId&, const UniqueWriterId&) -> bool;
    friend class WriterDetailsView;
 
    explicit UniqueWriterId(iox2_unique_writer_id_h handle);
    void drop();
 
    iox2_unique_writer_id_h m_handle = nullptr;
    mutable bb::Optional<RawIdType> m_raw_id;
};
 
auto operator==(const UniquePublisherId& lhs, const UniquePublisherId& rhs) -> bool;
auto operator<(const UniquePublisherId& lhs, const UniquePublisherId& rhs) -> bool;
auto operator==(const UniqueSubscriberId& lhs, const UniqueSubscriberId& rhs) -> bool;
auto operator<(const UniqueSubscriberId& lhs, const UniqueSubscriberId& rhs) -> bool;
auto operator==(const UniqueNotifierId& lhs, const UniqueNotifierId& rhs) -> bool;
auto operator<(const UniqueNotifierId& lhs, const UniqueNotifierId& rhs) -> bool;
auto operator==(const UniqueListenerId& lhs, const UniqueListenerId& rhs) -> bool;
auto operator<(const UniqueListenerId& lhs, const UniqueListenerId& rhs) -> bool;
auto operator==(const UniqueClientId& lhs, const UniqueClientId& rhs) -> bool;
auto operator<(const UniqueClientId& lhs, const UniqueClientId& rhs) -> bool;
auto operator==(const UniqueServerId& lhs, const UniqueServerId& rhs) -> bool;
auto operator<(const UniqueServerId& lhs, const UniqueServerId& rhs) -> bool;
auto operator==(const UniqueReaderId& lhs, const UniqueReaderId& rhs) -> bool;
auto operator<(const UniqueReaderId& lhs, const UniqueReaderId& rhs) -> bool;
auto operator==(const UniqueWriterId& lhs, const UniqueWriterId& rhs) -> bool;
auto operator<(const UniqueWriterId& lhs, const UniqueWriterId& rhs) -> bool;
 
} // namespace iox2
 
#endif