datagram_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 <cstdint>
#include <optional>
#include <span>
#include <string_view>
 
namespace idfxx::net {
 
class [[nodiscard]] datagram_socket : public detail::connectionless_socket_base {
public:
    struct config {
        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;
        bool reuse_address = false;
        bool broadcast = false;
#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
    datagram_socket();
#endif
 
    [[nodiscard]] static result<datagram_socket> make();
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    explicit datagram_socket(address_family fam);
#endif
 
    [[nodiscard]] static result<datagram_socket> make(address_family fam);
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    explicit datagram_socket(const config& cfg);
#endif
 
    [[nodiscard]] static result<datagram_socket> make(const config& cfg);
 
    // ----- send -----
 
#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);
 
    // ----- options -----
 
    void set_broadcast(bool on) noexcept;
 
    // ----- multicast (IPv4) -----
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    void join_multicast_v4(ipv4_addr group, ipv4_addr interface = {}) {
        idfxx::unwrap(try_join_multicast_v4(group, interface));
    }
#endif
 
    [[nodiscard]] result<void> try_join_multicast_v4(ipv4_addr group, ipv4_addr interface = {});
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    void leave_multicast_v4(ipv4_addr group, ipv4_addr interface = {}) {
        idfxx::unwrap(try_leave_multicast_v4(group, interface));
    }
#endif
 
    result<void> try_leave_multicast_v4(ipv4_addr group, ipv4_addr interface = {});
 
    void set_multicast_loopback(bool on) noexcept;
 
    void set_multicast_hops(uint8_t hops) noexcept;
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    void set_multicast_interface_v4(ipv4_addr addr) { idfxx::unwrap(try_set_multicast_interface_v4(addr)); }
#endif
 
    [[nodiscard]] result<void> try_set_multicast_interface_v4(ipv4_addr addr);
 
#ifdef CONFIG_LWIP_IPV6
    // ----- multicast (IPv6) -----
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    void join_multicast_v6(ipv6_addr group, uint8_t if_index = 0) {
        idfxx::unwrap(try_join_multicast_v6(group, if_index));
    }
#endif
 
    [[nodiscard]] result<void> try_join_multicast_v6(ipv6_addr group, uint8_t if_index = 0);
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    void leave_multicast_v6(ipv6_addr group, uint8_t if_index = 0) {
        idfxx::unwrap(try_leave_multicast_v6(group, if_index));
    }
#endif
 
    result<void> try_leave_multicast_v6(ipv6_addr group, uint8_t if_index = 0);
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    void set_multicast_interface_v6(uint8_t if_index) { idfxx::unwrap(try_set_multicast_interface_v6(if_index)); }
#endif
 
    [[nodiscard]] result<void> try_set_multicast_interface_v6(uint8_t if_index);
#endif
 
private:
    datagram_socket(int fd, address_family fam) noexcept
        : connectionless_socket_base(fd, fam) {}
};
 
} // namespace idfxx::net