raw_socket.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 Chris Leishman
 
#pragma once
 
#include "sdkconfig.h"
 
#include <idfxx/net/detail/connectionless_socket_base.hpp>
#include <idfxx/net/endpoint>
#include <idfxx/net/error>
 
#include <chrono>
#include <cstddef>
#include <optional>
#include <span>
#include <string_view>
 
namespace idfxx::net {
 
class [[nodiscard]] raw_socket : public detail::connectionless_socket_base {
public:
    struct config {
        ip_protocol protocol = {};                    
        address_family family = address_family::ipv4; 
        bool non_blocking = false;
        std::optional<std::chrono::milliseconds> recv_timeout = std::nullopt;
        std::optional<std::chrono::milliseconds> send_timeout = std::nullopt;
#ifdef CONFIG_LWIP_IPV6
        bool ipv6_only = false;
#endif
        std::optional<std::string_view> bind_to_device = std::nullopt;
    };
 
    // ----- construction -----
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    explicit raw_socket(ip_protocol protocol);
#endif
 
    [[nodiscard]] static result<raw_socket> make(ip_protocol protocol);
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    raw_socket(ip_protocol protocol, address_family fam);
#endif
 
    [[nodiscard]] static result<raw_socket> make(ip_protocol protocol, address_family fam);
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    explicit raw_socket(const config& cfg);
#endif
 
    [[nodiscard]] static result<raw_socket> make(const config& cfg);
 
    // ----- I/O -----
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    size_t send(std::span<const std::byte> buf) { return idfxx::unwrap(try_send(buf)); }
#endif
 
    [[nodiscard]] result<size_t> try_send(std::span<const std::byte> buf);
 
private:
    struct from_fd_t {
        explicit from_fd_t() = default;
    };
 
    raw_socket(from_fd_t, int fd, address_family fam) noexcept
        : connectionless_socket_base(fd, fam) {}
};
 
} // namespace idfxx::net