datagram_channel.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/endpoint>
#include <idfxx/net/error>
#include <idfxx/net/netconn/buffer>
#include <idfxx/net/netconn/detail/connectionless_channel.hpp>
 
#include <cstddef>
#include <cstdint>
#include <span>
 
namespace idfxx::net::netconn {
 
enum class udp_variant : int {
    standard,    
    lite,        
    no_checksum, 
};
 
class [[nodiscard]] datagram_channel : public detail::connectionless_channel {
public:
    // ----- construction -----
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    datagram_channel();
#endif
 
    [[nodiscard]] static result<datagram_channel> make();
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    explicit datagram_channel(address_family fam, udp_variant variant = udp_variant::standard);
#endif
 
    [[nodiscard]] static result<datagram_channel> make(address_family fam, udp_variant variant = udp_variant::standard);
 
    // ----- multicast -----
 
#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 = {});
 
private:
    datagram_channel(::netconn* conn, address_family fam) noexcept
        : connectionless_channel(conn, fam) {}
};
 
} // namespace idfxx::net::netconn