socket_handle.hpp

Go to the documentation of this file.

/* Copyright 2025 Kevin Exton
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
#ifndef IO_SOCKET_HANDLE_HPP
#define IO_SOCKET_HANDLE_HPP
#include "detail/socket.hpp"
 
#include <atomic>
#include <mutex>
// Forward Declarations for testing.
#ifndef NDEBUG
namespace io::socket {
auto is_valid_socket(native_socket_type handle) -> bool;
} // namespace io::socket
#endif // NDEBUG
namespace io::socket {
class socket_handle {
 
public:
  socket_handle() = default;
 
  socket_handle(const socket_handle &other) = delete;
  auto operator=(const socket_handle &other) -> socket_handle & = delete;
 
  socket_handle(socket_handle &&other) noexcept;
 
  auto operator=(socket_handle &&other) noexcept -> socket_handle &;
 
  explicit socket_handle(native_socket_type handle);
 
  explicit socket_handle(int domain, int type, int protocol);
 
  explicit operator native_socket_type() const noexcept;
 
  friend auto swap(socket_handle &lhs, socket_handle &rhs) noexcept -> void;
 
  [[nodiscard]] explicit operator bool() const noexcept;
 
  auto operator<=>(const socket_handle &other) const noexcept
      -> std::strong_ordering;
 
  auto operator==(const socket_handle &other) const noexcept -> bool;
 
  auto
  operator<=>(native_socket_type other) const noexcept -> std::strong_ordering;
 
  auto operator==(native_socket_type other) const noexcept -> bool;
 
  auto set_error(int error) noexcept -> void;
 
  auto get_error() const noexcept -> std::error_code;
 
  ~socket_handle();
 
private:
  auto close() noexcept -> void;
 
  std::atomic<native_socket_type> socket_{INVALID_SOCKET};
  std::atomic<int> error_;
  mutable std::mutex mtx_;
};
 
} // namespace io::socket
 
#include "detail/sync_operations.hpp"  // IWYU pragma: export
#include "impl/socket_handle_impl.hpp" // IWYU pragma: export
 
#endif // IO_SOCKET_HANDLE_HPP