file_descriptor.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_FILE_DESCRIPTOR_HPP
#define IOX2_FILE_DESCRIPTOR_HPP
 
#include "iox2/bb/optional.hpp"
#include "iox2/internal/iceoryx2.hpp"
 
namespace iox2 {
class FileDescriptorView;
 
class FileDescriptorBased {
  public:
    FileDescriptorBased() = default;
    FileDescriptorBased(const FileDescriptorBased&) = default;
    FileDescriptorBased(FileDescriptorBased&&) = default;
    auto operator=(const FileDescriptorBased&) -> FileDescriptorBased& = default;
    auto operator=(FileDescriptorBased&&) -> FileDescriptorBased& = default;
    virtual ~FileDescriptorBased() = default;
 
    virtual auto file_descriptor() const -> FileDescriptorView = 0;
};
 
class FileDescriptorView : public FileDescriptorBased {
  public:
    auto file_descriptor() const -> FileDescriptorView override;
 
    auto unsafe_native_handle() const -> int32_t;
 
  private:
    template <ServiceType>
    friend class WaitSet;
    friend class FileDescriptor;
    template <ServiceType>
    friend class Listener;
 
    explicit FileDescriptorView(iox2_file_descriptor_ptr handle);
 
    iox2_file_descriptor_ptr m_handle = nullptr;
};
 
class FileDescriptor {
  public:
    static auto create_owning(int32_t file_descriptor) -> bb::Optional<FileDescriptor>;
 
    static auto create_non_owning(int32_t file_descriptor) -> bb::Optional<FileDescriptor>;
 
    FileDescriptor(const FileDescriptor&) = delete;
    auto operator=(const FileDescriptor&) -> FileDescriptor& = delete;
 
    FileDescriptor(FileDescriptor&& rhs) noexcept;
    auto operator=(FileDescriptor&& rhs) noexcept -> FileDescriptor&;
    ~FileDescriptor();
 
    auto unsafe_native_handle() const -> int32_t;
 
    auto as_view() const -> FileDescriptorView;
 
  private:
    explicit FileDescriptor(iox2_file_descriptor_h handle);
    void drop();
 
    iox2_file_descriptor_h m_handle = nullptr;
};
 
} // namespace iox2
 
#endif