base_channel.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 Chris Leishman
 
#pragma once
 
 
// Internal base class shared by the netconn channel types
// (`stream_channel`, `datagram_channel`, `raw_channel`, `listener`). Holds
// the owning `::netconn*` pointer, the address family, and the family-generic
// options that belong on every type.
 
#include "sdkconfig.h"
 
#include <idfxx/net/endpoint>
#include <idfxx/net/error>
 
#include <chrono>
#include <cstdint>
#include <optional>
 
// Forward declaration from lwIP.
struct netconn;
 
namespace idfxx::net::netconn::detail {
 
[[nodiscard]] result<::netconn*> make_netconn(int base_type, address_family fam);
 
[[nodiscard]] result<::netconn*> make_netconn_with_proto(int base_type, uint8_t proto, address_family fam);
 
class base_channel {
public:
    ~base_channel() noexcept;
 
    base_channel(const base_channel&) = delete;
    base_channel& operator=(const base_channel&) = delete;
 
    base_channel(base_channel&& other) noexcept;
    base_channel& operator=(base_channel&& other) noexcept;
 
    [[nodiscard]] ::netconn* idf_handle() const noexcept { return _conn; }
 
    [[nodiscard]] address_family family() const noexcept { return _family; }
 
    [[nodiscard]] bool is_open() const noexcept { return _conn != nullptr; }
 
    [[nodiscard]] std::optional<endpoint> local_endpoint() const noexcept;
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    void bind(const endpoint& addr) { idfxx::unwrap(try_bind(addr)); }
#endif
 
    [[nodiscard]] result<void> try_bind(const endpoint& addr);
 
    template<typename Rep, typename Period>
    void set_recv_timeout(const std::chrono::duration<Rep, Period>& t) noexcept {
        _set_recv_timeout(std::chrono::ceil<std::chrono::milliseconds>(t));
    }
 
    void set_non_blocking(bool on) noexcept;
 
    [[nodiscard]] int get_recv_timeout() const noexcept;
 
protected:
    base_channel() noexcept = default;
    base_channel(::netconn* conn, address_family fam) noexcept
        : _conn(conn)
        , _family(fam) {}
 
    // Queries the netconn for its local (local == true) or peer (local ==
    // false) address. Shared by `local_endpoint` and the derived channels'
    // `peer_endpoint`. Returns `errc::invalid_state` on a moved-from channel.
    [[nodiscard]] result<endpoint> _try_getaddr(bool local) const;
 
    void _set_recv_timeout(std::chrono::milliseconds t) noexcept;
 
    ::netconn* _conn = nullptr;
    address_family _family = address_family::ipv4;
};
 
} // namespace idfxx::net::netconn::detail