- Driver acks each completed DDP frame; the test waits for the acks before broadcasting the sync. - Sync listener on UDP 4049: a frame is held until the next sync, then shown. - DDP pixels are shown at full brightness, ignoring the device brightness settings. - "DDP and sync receive on" setting (NVS, network API, web UI); off ignores DDP and sync packets. - ddp_test.py: finds devices on the subnet, drives them in lockstep at a fixed rate, runs animations. - /api/ddp reports sync counters for diagnosis. - Includes in-progress WebSocket, multi-driver web UI and Wi-Fi work from the same tree. Co-Authored-By: Claude Haiku 5.5 <noreply@anthropic.com>
205 lines
8.3 KiB
C
205 lines
8.3 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
#pragma once
|
|
|
|
#include <stddef.h>
|
|
#include "mdns_private.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Check if a host has a service by hostname, esp_netif, ip_protocol, service, and proto.
|
|
*
|
|
* @param hostname The hostname to check.
|
|
* @param esp_netif Pointer to the esp_netif to check.
|
|
* @param ip_protocol IP protocol to check.
|
|
* @param service The service name to check.
|
|
* @param proto The protocol to check.
|
|
*
|
|
* @return true if the host has the service, false otherwise.
|
|
*/
|
|
bool mdns_priv_cache_host_has_service(const char *hostname, const esp_netif_t *esp_netif, mdns_ip_protocol_t ip_protocol,
|
|
const char *service, const char *proto);
|
|
|
|
/**
|
|
* @brief Find the subtype node in a service cache by subtype name.
|
|
*
|
|
* @param service Pointer to the service cache.
|
|
* @param subtype The subtype name to find.
|
|
*
|
|
* @return Pointer to the subtype node if found, NULL otherwise.
|
|
*/
|
|
const mdns_cache_subtype_t *mdns_priv_cache_service_find_subtype(const mdns_service_cache_t *service, const char *subtype);
|
|
|
|
/**
|
|
* @brief Update a PTR record for service cache `_service._proto` with possible subtype.
|
|
*
|
|
* @param esp_netif Pointer to the esp_netif.
|
|
* @param ip_protocol IP protocol.
|
|
* @param instance The instance name.
|
|
* @param service The service name.
|
|
* @param proto The protocol.
|
|
* @param subtype The subtype, or null/empty for base PTR record.
|
|
* @param ttl The PTR TTL.
|
|
*
|
|
* @return The result of the update, see @ref mdns_cache_update_result_t.
|
|
*
|
|
* @note The PTR record will be marked to-sync when:
|
|
* - A new service is added to the cache.
|
|
* - A new subtype is appended to the service cache.
|
|
* - The PTR TTL is updated.
|
|
*
|
|
* @note A TTL=0 goodbye notifies only the matching base/subtype browsers and
|
|
* removes only that PTR record. Other cached records are preserved.
|
|
*/
|
|
mdns_cache_update_result_t mdns_priv_cache_update_ptr(const esp_netif_t *esp_netif, mdns_ip_protocol_t ip_protocol,
|
|
const char *instance, const char *service, const char *proto,
|
|
const char *subtype, uint32_t ttl);
|
|
|
|
/**
|
|
* @brief Update a SRV record for service cache `instance._service._proto`.
|
|
*
|
|
* @param esp_netif Pointer to the esp_netif.
|
|
* @param ip_protocol IP protocol.
|
|
* @param hostname The hostname to update.
|
|
* @param instance The instance name.
|
|
* @param service The service name.
|
|
* @param proto The protocol.
|
|
* @param priority The priority to update.
|
|
* @param weight The weight to update.
|
|
* @param port The port to update.
|
|
* @param ttl The SRV TTL.
|
|
*
|
|
* @return The result of the update, see @ref mdns_cache_update_result_t.
|
|
*
|
|
* @note The SRV record will be marked to-sync when:
|
|
* - A new SRV record is added to the service cache.
|
|
* - The service cache is moved to the host designated by @ref hostname.
|
|
* - The SRV record is updated.
|
|
* - Receives a TTL=0 goodbye: the SRV record will be marked as absent.
|
|
*/
|
|
mdns_cache_update_result_t mdns_priv_cache_update_srv(const esp_netif_t *esp_netif, mdns_ip_protocol_t ip_protocol,
|
|
const char *hostname, const char *instance, const char *service,
|
|
const char *proto, uint16_t priority, uint16_t weight,
|
|
uint16_t port, uint32_t ttl);
|
|
|
|
/**
|
|
* @brief Update a TXT record for service cache `instance._service._proto`.
|
|
*
|
|
* @param esp_netif Pointer to the esp_netif.
|
|
* @param ip_protocol IP protocol.
|
|
* @param instance The instance name.
|
|
* @param service The service name.
|
|
* @param proto The protocol.
|
|
* @param txt The TXT record to update.
|
|
* @param ttl The TXT TTL.
|
|
*
|
|
* @return The result of the update, see @ref mdns_cache_update_result_t.
|
|
*
|
|
* @note The TXT record will be marked to-sync when:
|
|
* - A new TXT record is added to the service cache.
|
|
* - The TXT record is updated.
|
|
* - Receives a TTL=0 goodbye: the TXT record will be marked as absent.
|
|
*/
|
|
mdns_cache_update_result_t mdns_priv_cache_update_txt(const esp_netif_t *esp_netif, mdns_ip_protocol_t ip_protocol,
|
|
const char *instance, const char *service, const char *proto,
|
|
mdns_txt_linked_item_t *txt, uint32_t ttl);
|
|
|
|
/**
|
|
* @brief Update an A/AAAA record for a cache entry `hostname`.
|
|
*
|
|
* @param esp_netif Pointer to the esp_netif.
|
|
* @param ip_protocol IP protocol.
|
|
* @param hostname The hostname to update.
|
|
* @param addr The address to update.
|
|
* @param ttl The TTL.
|
|
*
|
|
* @return The result of the update, see @ref mdns_cache_update_result_t.
|
|
*
|
|
* @note When an A/AAAA record is updated (added, removed, or updated),
|
|
* all services under this cache entry will be marked to-sync for browses.
|
|
*/
|
|
mdns_cache_update_result_t mdns_priv_cache_update_addr(const esp_netif_t *esp_netif, mdns_ip_protocol_t ip_protocol,
|
|
const char *hostname, const esp_ip_addr_t *addr, uint32_t ttl);
|
|
|
|
/**
|
|
* @brief Update an A/AAAA record for an existing cache entry `hostname`.
|
|
*
|
|
* @param esp_netif Pointer to the esp_netif.
|
|
* @param ip_protocol IP protocol.
|
|
* @param hostname The hostname to update.
|
|
* @param addr The address to update.
|
|
* @param ttl The TTL.
|
|
*
|
|
* @return The result of the update, see @ref mdns_cache_update_result_t.
|
|
* If the cache entry does not exist, or no consumers subscribe to the hostname or service under the hostname,
|
|
* return MDNS_CACHE_NO_CHANGE.
|
|
*
|
|
* @note When an A/AAAA record is updated (added, removed, or updated),
|
|
* all services under this cache entry will be marked to-sync for browses.
|
|
*
|
|
* @note Used by browses in case ADDR records come before SRV record.
|
|
*/
|
|
mdns_cache_update_result_t mdns_priv_cache_update_existing_addr(const esp_netif_t *esp_netif, mdns_ip_protocol_t ip_protocol,
|
|
const char *hostname, const esp_ip_addr_t *addr, uint32_t ttl);
|
|
|
|
/**
|
|
* @brief Remove expired records from the entire cache.
|
|
*
|
|
* @param now_us The current time in microseconds from esp_timer_get_time().
|
|
*
|
|
* @note This function is called in mDNS service task while holding service lock.
|
|
* PTR expiration notifies browses immediately, other records are marked to-sync for browses.
|
|
*/
|
|
void mdns_priv_cache_remove_expired_records(int64_t now_us);
|
|
|
|
/**
|
|
* @brief Trim down the expiration time of unsubscribed records.
|
|
*
|
|
* @param now_us The current time in microseconds from esp_timer_get_time().
|
|
*
|
|
* @note This function scans through s_expiry and sets the expiration time of unsubscribed records to
|
|
* `min(expires_at_us, now_us + MDNS_CACHE_UNSUBSCRIBED_GRACE_SEC * MDNS_US_PER_SEC)`.
|
|
* Finally cleaned up in service task by `mdns_priv_cache_remove_expired_records()`.
|
|
*/
|
|
void mdns_priv_cache_trim_unsubscribed_records(int64_t now_us);
|
|
|
|
/**
|
|
* @brief Clear all cache entries.
|
|
*/
|
|
void mdns_priv_cache_clear(void);
|
|
|
|
/**
|
|
* @brief Convert a service cache to a mdns_result_t.
|
|
*
|
|
* @param entry Pointer to the cache entry.
|
|
* @param service Pointer to the service cache.
|
|
* @param out_result Pointer to the output mdns_result_t.
|
|
* @return ESP_OK on success, ESP_ERR_NO_MEM on allocation failure.
|
|
*/
|
|
esp_err_t mdns_priv_service_cache_to_result(const mdns_cache_entry_t *entry, const mdns_service_cache_t *service,
|
|
mdns_result_t **out_result);
|
|
|
|
/**
|
|
* @brief Process all pending synchronization cache entries.
|
|
*
|
|
* @note This function is called by the MDNS task to process all pending synchronization cache entries.
|
|
* It will generate temporary results, notify corresponding consumers, and clear the sync out flags.
|
|
*/
|
|
void mdns_priv_cache_process_sync(void);
|
|
|
|
/**
|
|
* @brief Replay all currently visible cache services to a newly registered browse.
|
|
*
|
|
* @return true if successfully notified, false otherwise
|
|
*/
|
|
bool mdns_priv_cache_notify_browse(mdns_browse_t *browse);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|