DNS-SD responder (DNS-Based Service Discovery) More...
#include "core/net.h"#include "mdns/mdns_responder.h"#include "dns_sd/dns_sd_responder.h"#include "dns_sd/dns_sd_responder_misc.h"#include "debug.h"Go to the source code of this file.
Macros | |
| #define | TRACE_LEVEL DNS_SD_TRACE_LEVEL |
Variables | |
| systime_t | dnsSdResponderTickCounter |
Detailed Description
DNS-SD responder (DNS-Based Service Discovery)
License
SPDX-License-Identifier: GPL-2.0-or-later
Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
This file is part of CycloneTCP Open.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Description
DNS-SD allows clients to discover a list of named instances of that desired service, using standard DNS queries. Refer to the following RFCs for complete details:
- RFC 6763: DNS-Based Service Discovery
- RFC 2782: A DNS RR for specifying the location of services (DNS SRV)
- Version
- 2.4.4
Definition in file dns_sd_responder.c.
Macro Definition Documentation
◆ TRACE_LEVEL
| #define TRACE_LEVEL DNS_SD_TRACE_LEVEL |
Definition at line 40 of file dns_sd_responder.c.
Function Documentation
◆ dnsSdResponderGetDefaultSettings()
| void dnsSdResponderGetDefaultSettings | ( | DnsSdResponderSettings * | settings | ) |
Initialize settings with default values.
- Parameters
-
[out] settings Structure that contains DNS-SD responder settings
Definition at line 61 of file dns_sd_responder.c.
◆ dnsSdResponderInit()
| error_t dnsSdResponderInit | ( | DnsSdResponderContext * | context, |
| const DnsSdResponderSettings * | settings | ||
| ) |
DNS-DS initialization.
- Parameters
-
[in] context Pointer to the DNS-SD responder context [in] settings DNS-SD specific settings
- Returns
- Error code
Definition at line 86 of file dns_sd_responder.c.
◆ dnsSdResponderLinkChangeEvent()
| void dnsSdResponderLinkChangeEvent | ( | DnsSdResponderContext * | context | ) |
Callback function for link change event.
- Parameters
-
[in] context Pointer to the DNS-SD responder context
Definition at line 622 of file dns_sd_responder.c.
◆ dnsSdResponderRegisterService()
| error_t dnsSdResponderRegisterService | ( | DnsSdResponderContext * | context, |
| uint_t | index, | ||
| const char_t * | instanceName, | ||
| const char_t * | serviceName, | ||
| uint16_t | priority, | ||
| uint16_t | weight, | ||
| uint16_t | port, | ||
| const char_t * | metadata | ||
| ) |
Register a DNS-SD service.
- Parameters
-
[in] context Pointer to the DNS-SD responder context [in] index Zero-based index identifying a slot [in] instanceName NULL-terminated string that contains the service instance name [in] serviceName NULL-terminated string that contains the name of the service to be registered [in] priority Priority field [in] weight Weight field [in] port Port number [in] metadata NULL-terminated string that contains the discovery-time metadata (TXT record)
- Returns
- Error code
Definition at line 239 of file dns_sd_responder.c.
◆ dnsSdResponderStart()
| error_t dnsSdResponderStart | ( | DnsSdResponderContext * | context | ) |
Start DNS-SD responder.
- Parameters
-
[in] context Pointer to the DNS-SD responder context
- Returns
- Error code
Definition at line 153 of file dns_sd_responder.c.
◆ dnsSdResponderStartProbing()
| error_t dnsSdResponderStartProbing | ( | DnsSdResponderContext * | context | ) |
Restart probing process.
- Parameters
-
[in] context Pointer to the DNS-SD responder context
- Returns
- Error code
Definition at line 410 of file dns_sd_responder.c.
◆ dnsSdResponderStop()
| error_t dnsSdResponderStop | ( | DnsSdResponderContext * | context | ) |
Stop DNS-SD responder.
- Parameters
-
[in] context Pointer to the DNS-SD responder context
- Returns
- Error code
Definition at line 191 of file dns_sd_responder.c.
◆ dnsSdResponderTick()
| void dnsSdResponderTick | ( | DnsSdResponderContext * | context | ) |
DNS-SD responder timer handler.
This routine must be periodically called by the TCP/IP stack to manage DNS-SD operation
- Parameters
-
[in] context Pointer to the DNS-SD responder context
Definition at line 439 of file dns_sd_responder.c.
◆ dnsSdResponderUnregisterService()
| error_t dnsSdResponderUnregisterService | ( | DnsSdResponderContext * | context, |
| uint_t | index | ||
| ) |
Unregister a DNS-SD service.
- Parameters
-
[in] context Pointer to the DNS-SD responder context [in] index Zero-based index identifying the service to be unregistered
- Returns
- Error code
Definition at line 365 of file dns_sd_responder.c.
Variable Documentation
◆ dnsSdResponderTickCounter
| systime_t dnsSdResponderTickCounter |
Definition at line 53 of file dns_sd_responder.c.