ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::udp::UDPComponent Class Referencefinal

#include <udp_component.h>

Inheritance diagram for esphome::udp::UDPComponent:
esphome::Component

Data Structures

union  SockaddrEntry
 

Public Member Functions

void set_addresses (const char *const *addresses)
 nullptr-terminated table of addresses; must outlive the component.
 
void set_listen_address (const char *listen_addr)
 Multicast group literal; must outlive the component.
 
void set_listen_port (uint16_t port)
 
void set_broadcast_port (uint16_t port)
 
void set_should_broadcast ()
 
void set_should_listen ()
 
void set_ipv6_send (bool multicast)
 This instance has IPv6 destinations; multicast ones also need an egress interface.
 
void set_ipv4_send (bool ipv4_send)
 An instance whose destinations are all IPv6 needs no IPv4 send socket.
 
void set_omr_source ()
 A destination is off the Thread mesh, so the IPv6 send socket must be bound to the OMR address first.
 
template<typename F >
void add_listener (F &&listener)
 
void setup () override
 
void loop () override
 
void dump_config () override
 
bool send_packet (const uint8_t *data, size_t size)
 Returns false if the packet could not be sent to every destination.
 
bool send_packet (const std::vector< uint8_t > &buf)
 
float get_setup_priority () const override
 
- Public Member Functions inherited from esphome::Component
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
virtual bool teardown ()
 Called during teardown to allow component to gracefully finish operations.
 
virtual void on_powerdown ()
 Called last before a reboot or deep sleep to power down hardware.
 
uint8_t get_component_state () const
 
void reset_to_construction_state ()
 Reset this component back to the construction state to allow setup to run again.
 
bool is_in_loop_state () const
 Check if this component has completed setup and is in the loop state.
 
bool is_idle () const
 Check if this component is idle.
 
void mark_failed ()
 Mark this component as failed.
 
void mark_failed (const LogString *message)
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok)
 Marks the component failed with message (default "Communication failed") unless ok; returns ok.
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok, const LogString *message)
 
void disable_loop ()
 Disable this component's loop.
 
void enable_loop ()
 Enable this component's loop.
 
void enable_loop_soon_any_context ()
 Thread and ISR-safe version of enable_loop() that can be called from any context.
 
bool is_failed () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning ()
 
void status_set_warning (const char *message)
 
void status_set_warning (const LogString *message)
 
bool status_comm_result (bool ok)
 Clears the warning when ok, else sets it with message (default "Communication failed"); returns ok.
 
bool status_comm_result (bool ok, const LogString *message)
 
void status_set_error ()
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
 ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name
 
void status_momentary_warning (uint32_t length=5000)
 Set warning status flag and clear it after length ms.
 
void status_momentary_warning (const LogString *message, uint32_t length=5000)
 
 ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name
 
void status_momentary_error (uint32_t length=5000)
 Set error status flag and clear it after length ms.
 
void status_momentary_error (const LogString *message, uint32_t length=5000)
 
bool has_overridden_loop () const
 
const LogString * get_component_log_str () const ESPHOME_ALWAYS_INLINE
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)
 

Protected Types

enum  PollStep : uint8_t {
  POLL_JOIN = 1 , POLL_BIND = 2 , POLL_MCAST_IF = 4 , POLL_SRC_BIND = 8 ,
  POLL_SEND_HELD = 16
}
 

Protected Member Functions

bool network_poll_ ()
 One pass of the network poll; true once nothing is left to do.
 
void set_poll_warning_ (PollStep step, const LogString *what, int err)
 err is the errno of the failed call, or 0 when no call failed.
 
- Protected Member Functions inherited from esphome::Component
friend void::setup ()
 
friend void::original_setup ()
 
void set_component_source_ (uint8_t index)
 Set where this component was loaded from for some debug messages.
 
virtual void call_setup ()
 
void call_dump_config_ ()
 
void enable_loop_slow_path_ ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
bool set_status_flag_ (uint8_t flag)
 Helper to set a status LED flag on both this component and the app.
 
bool set_error_flag_ (const LogString *message)
 Set the error flag and log it; true when it was not set before.
 
void set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a const char* name.
 
void set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a numeric ID (zero heap allocation).
 
void set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const char *name)
 Cancel an interval function.
 
bool cancel_interval (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
void set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a const char* name.
 
void set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a numeric ID (zero heap allocation).
 
void set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const char *name)
 Cancel a timeout function.
 
bool cancel_timeout (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
void defer (const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call with a const char* name.
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
void defer (uint32_t id, std::function< void()> &&f)
 Defer a callback with a numeric ID (zero heap allocation)
 
bool cancel_defer (const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
bool cancel_defer (uint32_t id)
 
void status_clear_warning_slow_path_ ()
 
void status_clear_error_slow_path_ ()
 

Protected Attributes

LazyCallbackManager< void(std::span< const uint8_t >)> packet_listeners_ {}
 
std::unique_ptr< socket::UDPSendSocket > broadcast_socket_ = nullptr
 
std::unique_ptr< socket::UDPSocket > listen_socket_ = nullptr
 
std::unique_ptr< socket::UDPSendSocket > send_socket_v6_ = nullptr
 
FixedVector< SockaddrEntry > sockaddrs_ {}
 
const char *const * addresses_ {nullptr}
 
const char * listen_address_ {nullptr}
 
uint32_t mcast_ifindex_ {0}
 
uint16_t listen_port_ {}
 
uint16_t broadcast_port_ {}
 
bool should_broadcast_ {}
 
bool should_listen_ {}
 
uint8_t poll_pending_ {}
 
uint8_t poll_failed_ {}
 
bool poll_warning_ {}
 
bool ipv4_send_ {true}
 
bool ipv6_send_ {}
 
bool ipv6_multicast_ {}
 
- Protected Attributes inherited from esphome::Component
uint8_t component_source_index_ {0}
 Index into component source PROGMEM lookup table (0 = not set)
 
uint8_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
 Warn threshold in centiseconds (max 2550ms)
 
uint8_t component_state_ {0x00}
 State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 
ComponentRuntimeStats runtime_stats_
 

Additional Inherited Members

- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 

Detailed Description

Definition at line 15 of file udp_component.h.

Member Enumeration Documentation

◆ PollStep

enum esphome::udp::UDPComponent::PollStep : uint8_t
protected
Enumerator
POLL_JOIN 
POLL_BIND 
POLL_MCAST_IF 
POLL_SRC_BIND 
POLL_SEND_HELD 

Definition at line 49 of file udp_component.h.

Member Function Documentation

◆ add_listener()

template<typename F >
void esphome::udp::UDPComponent::add_listener ( F && listener)
inline

Definition at line 39 of file udp_component.h.

◆ dump_config()

void esphome::udp::UDPComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 265 of file udp_component.cpp.

◆ get_setup_priority()

float esphome::udp::UDPComponent::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 46 of file udp_component.h.

◆ loop()

void esphome::udp::UDPComponent::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 242 of file udp_component.cpp.

◆ network_poll_()

bool esphome::udp::UDPComponent::network_poll_ ( )
protected

One pass of the network poll; true once nothing is left to do.

Definition at line 146 of file udp_component.cpp.

◆ send_packet() [1/2]

bool esphome::udp::UDPComponent::send_packet ( const std::vector< uint8_t > & buf)
inline

Definition at line 45 of file udp_component.h.

◆ send_packet() [2/2]

bool esphome::udp::UDPComponent::send_packet ( const uint8_t * data,
size_t size )

Returns false if the packet could not be sent to every destination.

Definition at line 284 of file udp_component.cpp.

◆ set_addresses()

void esphome::udp::UDPComponent::set_addresses ( const char *const * addresses)
inline

nullptr-terminated table of addresses; must outlive the component.

Definition at line 18 of file udp_component.h.

◆ set_broadcast_port()

void esphome::udp::UDPComponent::set_broadcast_port ( uint16_t port)
inline

Definition at line 22 of file udp_component.h.

◆ set_ipv4_send()

void esphome::udp::UDPComponent::set_ipv4_send ( bool ipv4_send)
inline

An instance whose destinations are all IPv6 needs no IPv4 send socket.

Definition at line 32 of file udp_component.h.

◆ set_ipv6_send()

void esphome::udp::UDPComponent::set_ipv6_send ( bool multicast)
inline

This instance has IPv6 destinations; multicast ones also need an egress interface.

Definition at line 27 of file udp_component.h.

◆ set_listen_address()

void esphome::udp::UDPComponent::set_listen_address ( const char * listen_addr)
inline

Multicast group literal; must outlive the component.

Definition at line 20 of file udp_component.h.

◆ set_listen_port()

void esphome::udp::UDPComponent::set_listen_port ( uint16_t port)
inline

Definition at line 21 of file udp_component.h.

◆ set_omr_source()

void esphome::udp::UDPComponent::set_omr_source ( )
inline

A destination is off the Thread mesh, so the IPv6 send socket must be bound to the OMR address first.

Kept as the pending poll bit, as the bool members leave no padding.

Definition at line 37 of file udp_component.h.

◆ set_poll_warning_()

void esphome::udp::UDPComponent::set_poll_warning_ ( PollStep step,
const LogString * what,
int err )
protected

err is the errno of the failed call, or 0 when no call failed.

Definition at line 225 of file udp_component.cpp.

◆ set_should_broadcast()

void esphome::udp::UDPComponent::set_should_broadcast ( )
inline

Definition at line 23 of file udp_component.h.

◆ set_should_listen()

void esphome::udp::UDPComponent::set_should_listen ( )
inline

Definition at line 24 of file udp_component.h.

◆ setup()

void esphome::udp::UDPComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 17 of file udp_component.cpp.

Field Documentation

◆ addresses_

const char* const* esphome::udp::UDPComponent::addresses_ {nullptr}
protected

Definition at line 76 of file udp_component.h.

◆ broadcast_port_

uint16_t esphome::udp::UDPComponent::broadcast_port_ {}
protected

Definition at line 82 of file udp_component.h.

◆ broadcast_socket_

std::unique_ptr<socket::UDPSendSocket> esphome::udp::UDPComponent::broadcast_socket_ = nullptr
protected

Definition at line 70 of file udp_component.h.

◆ ipv4_send_

bool esphome::udp::UDPComponent::ipv4_send_ {true}
protected

Definition at line 89 of file udp_component.h.

◆ ipv6_multicast_

bool esphome::udp::UDPComponent::ipv6_multicast_ {}
protected

Definition at line 91 of file udp_component.h.

◆ ipv6_send_

bool esphome::udp::UDPComponent::ipv6_send_ {}
protected

Definition at line 90 of file udp_component.h.

◆ listen_address_

const char* esphome::udp::UDPComponent::listen_address_ {nullptr}
protected

Definition at line 77 of file udp_component.h.

◆ listen_port_

uint16_t esphome::udp::UDPComponent::listen_port_ {}
protected

Definition at line 81 of file udp_component.h.

◆ listen_socket_

std::unique_ptr<socket::UDPSocket> esphome::udp::UDPComponent::listen_socket_ = nullptr
protected

Definition at line 71 of file udp_component.h.

◆ mcast_ifindex_

uint32_t esphome::udp::UDPComponent::mcast_ifindex_ {0}
protected

Definition at line 79 of file udp_component.h.

◆ packet_listeners_

LazyCallbackManager<void(std::span<const uint8_t>)> esphome::udp::UDPComponent::packet_listeners_ {}
protected

Definition at line 69 of file udp_component.h.

◆ poll_failed_

uint8_t esphome::udp::UDPComponent::poll_failed_ {}
protected

Definition at line 86 of file udp_component.h.

◆ poll_pending_

uint8_t esphome::udp::UDPComponent::poll_pending_ {}
protected

Definition at line 85 of file udp_component.h.

◆ poll_warning_

bool esphome::udp::UDPComponent::poll_warning_ {}
protected

Definition at line 87 of file udp_component.h.

◆ send_socket_v6_

std::unique_ptr<socket::UDPSendSocket> esphome::udp::UDPComponent::send_socket_v6_ = nullptr
protected

Definition at line 73 of file udp_component.h.

◆ should_broadcast_

bool esphome::udp::UDPComponent::should_broadcast_ {}
protected

Definition at line 83 of file udp_component.h.

◆ should_listen_

bool esphome::udp::UDPComponent::should_listen_ {}
protected

Definition at line 84 of file udp_component.h.

◆ sockaddrs_

FixedVector<SockaddrEntry> esphome::udp::UDPComponent::sockaddrs_ {}
protected

Definition at line 75 of file udp_component.h.


The documentation for this class was generated from the following files: