dns_sd.h File Reference

DNS-SD (DNS-Based Service Discovery) More...

#include "core/net.h"
#include "dns/dns_common.h"
#include "mdns/mdns_common.h"

Go to the source code of this file.

Data Structures

struct  DnsSdSettings
 DNS-SD settings. More...
 
struct  DnsSdService
 DNS-SD service descriptor. More...
 
struct  _DnsSdContext
 DNS-SD context. More...
 

Macros

#define DNS_SD_SUPPORT   DISABLED
 
#define DNS_SD_TICK_INTERVAL   250
 
#define DNS_SD_SERVICE_LIST_SIZE   2
 
#define DNS_SD_MAX_SERVICE_NAME_LEN   16
 
#define DNS_SD_MAX_INSTANCE_NAME_LEN   32
 
#define DNS_SD_MAX_METADATA_LEN   128
 
#define DNS_SD_DEFAULT_RR_TTL   120
 
#define DnsSdContext   struct _DnsSdContext
 

Typedefs

typedef void(* DnsSdStateChangeCallback) (DnsSdContext *context, NetInterface *interface, MdnsState state)
 FSM state change callback. More...
 

Functions

void dnsSdGetDefaultSettings (DnsSdSettings *settings)
 Initialize settings with default values. More...
 
error_t dnsSdInit (DnsSdContext *context, const DnsSdSettings *settings)
 DNS-DS initialization. More...
 
error_t dnsSdStart (DnsSdContext *context)
 Start mDNS responder. More...
 
error_t dnsSdStop (DnsSdContext *context)
 Stop mDNS responder. More...
 
MdnsState dnsSdGetState (DnsSdContext *context)
 Retrieve current state. More...
 
error_t dnsSdSetInstanceName (DnsSdContext *context, const char_t *instanceName)
 Set service instance name. More...
 
error_t dnsSdRegisterService (DnsSdContext *context, const char_t *serviceName, uint16_t priority, uint16_t weight, uint16_t port, const char_t *metadata)
 Register a DNS-SD service. More...
 
error_t dnsSdUnregisterService (DnsSdContext *context, const char_t *serviceName)
 Unregister a DNS-SD service. More...
 
uint_t dnsSdGetNumServices (DnsSdContext *context)
 Get the number of registered services. More...
 
error_t dnsSdStartProbing (DnsSdContext *context)
 Restart probing process. More...
 
void dnsSdTick (DnsSdContext *interface)
 DNS-SD responder timer handler. More...
 
void dnsSdLinkChangeEvent (DnsSdContext *interface)
 Callback function for link change event. More...
 
void dnsSdChangeState (DnsSdContext *context, MdnsState newState, systime_t delay)
 Update FSM state. More...
 
void dnsSdChangeInstanceName (DnsSdContext *context)
 Programmatically change the service instance name. More...
 
error_t dnsSdSendProbe (DnsSdContext *context)
 Send probe packet. More...
 
error_t dnsSdSendAnnouncement (DnsSdContext *context)
 Send announcement packet. More...
 
error_t dnsSdSendGoodbye (DnsSdContext *context, const DnsSdService *service)
 Send goodbye packet. More...
 
error_t dnsSdParseQuestion (NetInterface *interface, const MdnsMessage *query, size_t offset, const DnsQuestion *question, MdnsMessage *response)
 Parse a question. More...
 
void dnsSdParseNsRecord (NetInterface *interface, const MdnsMessage *query, size_t offset, const DnsResourceRecord *record)
 Parse a resource record from the Authority Section. More...
 
void dnsSdParseAnRecord (NetInterface *interface, const MdnsMessage *response, size_t offset, const DnsResourceRecord *record)
 Parse a resource record from the Answer Section. More...
 
void dnsSdGenerateAdditionalRecords (NetInterface *interface, MdnsMessage *response, bool_t legacyUnicast)
 Additional record generation. More...
 
error_t dnsSdAddServiceEnumPtrRecord (NetInterface *interface, MdnsMessage *message, const DnsSdService *service, uint32_t ttl)
 Add PTR record to a mDNS message (in response to a meta-query) More...
 
error_t dnsSdAddPtrRecord (NetInterface *interface, MdnsMessage *message, const DnsSdService *service, uint32_t ttl)
 Add PTR record to a mDNS message. More...
 
error_t dnsSdAddSrvRecord (NetInterface *interface, MdnsMessage *message, const DnsSdService *service, bool_t cacheFlush, uint32_t ttl)
 Add SRV record to a mDNS message. More...
 
error_t dnsSdAddTxtRecord (NetInterface *interface, MdnsMessage *message, const DnsSdService *service, bool_t cacheFlush, uint32_t ttl)
 Add TXT record to a mDNS message. More...
 
error_t dnsSdAddNsecRecord (NetInterface *interface, MdnsMessage *message, const DnsSdService *service, bool_t cacheFlush, uint32_t ttl)
 Add NSEC record to a mDNS message. More...
 

Variables

systime_t dnsSdTickCounter
 

Detailed Description

DNS-SD (DNS-Based Service Discovery)

License

Copyright (C) 2010-2018 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.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
1.9.0

Definition in file dns_sd.h.

Macro Definition Documentation

◆ DNS_SD_DEFAULT_RR_TTL

#define DNS_SD_DEFAULT_RR_TTL   120

Definition at line 81 of file dns_sd.h.

◆ DNS_SD_MAX_INSTANCE_NAME_LEN

#define DNS_SD_MAX_INSTANCE_NAME_LEN   32

Definition at line 67 of file dns_sd.h.

◆ DNS_SD_MAX_METADATA_LEN

#define DNS_SD_MAX_METADATA_LEN   128

Definition at line 74 of file dns_sd.h.

◆ DNS_SD_MAX_SERVICE_NAME_LEN

#define DNS_SD_MAX_SERVICE_NAME_LEN   16

Definition at line 60 of file dns_sd.h.

◆ DNS_SD_SERVICE_LIST_SIZE

#define DNS_SD_SERVICE_LIST_SIZE   2

Definition at line 53 of file dns_sd.h.

◆ DNS_SD_SUPPORT

#define DNS_SD_SUPPORT   DISABLED

Definition at line 39 of file dns_sd.h.

◆ DNS_SD_TICK_INTERVAL

#define DNS_SD_TICK_INTERVAL   250

Definition at line 46 of file dns_sd.h.

◆ DnsSdContext

#define DnsSdContext   struct _DnsSdContext

Definition at line 88 of file dns_sd.h.

Typedef Documentation

◆ DnsSdStateChangeCallback

typedef void(* DnsSdStateChangeCallback) (DnsSdContext *context, NetInterface *interface, MdnsState state)

FSM state change callback.

Definition at line 100 of file dns_sd.h.

Function Documentation

◆ dnsSdAddNsecRecord()

error_t dnsSdAddNsecRecord ( NetInterface interface,
MdnsMessage message,
const DnsSdService service,
bool_t  cacheFlush,
uint32_t  ttl 
)

Add NSEC record to a mDNS message.

Parameters
[in]interfaceUnderlying network interface
[in,out]messagePointer to the mDNS message
[in]servicePointer to a DNS-SD service
[in]cacheFlushCache-flush bit
[in]ttlResource record TTL (cache lifetime)
Returns
Error code

Definition at line 1896 of file dns_sd.c.

◆ dnsSdAddPtrRecord()

error_t dnsSdAddPtrRecord ( NetInterface interface,
MdnsMessage message,
const DnsSdService service,
uint32_t  ttl 
)

Add PTR record to a mDNS message.

Parameters
[in]interfaceUnderlying network interface
[in,out]messagePointer to the mDNS message
[in]servicePointer to a DNS-SD service
[in]ttlResource record TTL (cache lifetime)
Returns
Error code

Definition at line 1630 of file dns_sd.c.

◆ dnsSdAddServiceEnumPtrRecord()

error_t dnsSdAddServiceEnumPtrRecord ( NetInterface interface,
MdnsMessage message,
const DnsSdService service,
uint32_t  ttl 
)

Add PTR record to a mDNS message (in response to a meta-query)

Parameters
[in]interfaceUnderlying network interface
[in,out]messagePointer to the mDNS message
[in]servicePointer to a DNS-SD service
[in]ttlResource record TTL (cache lifetime)
Returns
Error code

Definition at line 1561 of file dns_sd.c.

◆ dnsSdAddSrvRecord()

error_t dnsSdAddSrvRecord ( NetInterface interface,
MdnsMessage message,
const DnsSdService service,
bool_t  cacheFlush,
uint32_t  ttl 
)

Add SRV record to a mDNS message.

Parameters
[in]interfaceUnderlying network interface
[in,out]messagePointer to the mDNS message
[in]servicePointer to a DNS-SD service
[in]cacheFlushCache-flush bit
[in]ttlResource record TTL (cache lifetime)
Returns
Error code

Definition at line 1715 of file dns_sd.c.

◆ dnsSdAddTxtRecord()

error_t dnsSdAddTxtRecord ( NetInterface interface,
MdnsMessage message,
const DnsSdService service,
bool_t  cacheFlush,
uint32_t  ttl 
)

Add TXT record to a mDNS message.

Parameters
[in]interfaceUnderlying network interface
[in,out]messagePointer to the mDNS message
[in]servicePointer to a DNS-SD service
[in]cacheFlushCache-flush bit
[in]ttlResource record TTL (cache lifetime)
Returns
Error code

Definition at line 1813 of file dns_sd.c.

◆ dnsSdChangeInstanceName()

void dnsSdChangeInstanceName ( DnsSdContext context)

Programmatically change the service instance name.

Parameters
[in]contextPointer to the DNS-SD context

Definition at line 723 of file dns_sd.c.

◆ dnsSdChangeState()

void dnsSdChangeState ( DnsSdContext context,
MdnsState  newState,
systime_t  delay 
)

Update FSM state.

Parameters
[in]contextPointer to the DNS-SD context
[in]newStateNew state to switch to
[in]delayInitial delay

Definition at line 688 of file dns_sd.c.

◆ dnsSdGenerateAdditionalRecords()

void dnsSdGenerateAdditionalRecords ( NetInterface interface,
MdnsMessage response,
bool_t  legacyUnicast 
)

Additional record generation.

Parameters
[in]interfaceUnderlying network interface
[in,out]responsemDNS response message
[in]legacyUnicastThis flag is set for legacy unicast responses

Definition at line 1407 of file dns_sd.c.

◆ dnsSdGetDefaultSettings()

void dnsSdGetDefaultSettings ( DnsSdSettings settings)

Initialize settings with default values.

Parameters
[out]settingsStructure that contains DNS-SD settings

Definition at line 63 of file dns_sd.c.

◆ dnsSdGetNumServices()

uint_t dnsSdGetNumServices ( DnsSdContext context)

Get the number of registered services.

Parameters
[in]contextPointer to the DNS-SD context
Returns
Number of registered services

Definition at line 448 of file dns_sd.c.

◆ dnsSdGetState()

MdnsState dnsSdGetState ( DnsSdContext context)

Retrieve current state.

Parameters
[in]contextPointer to the DNS-SD context
Returns
Current DNS-SD state

Definition at line 188 of file dns_sd.c.

◆ dnsSdInit()

error_t dnsSdInit ( DnsSdContext context,
const DnsSdSettings settings 
)

DNS-DS initialization.

Parameters
[in]contextPointer to the DNS-SD context
[in]settingsDNS-SD specific settings
Returns
Error code

Definition at line 84 of file dns_sd.c.

◆ dnsSdLinkChangeEvent()

void dnsSdLinkChangeEvent ( DnsSdContext context)

Callback function for link change event.

Parameters
[in]contextPointer to the DNS-SD context

Definition at line 669 of file dns_sd.c.

◆ dnsSdParseAnRecord()

void dnsSdParseAnRecord ( NetInterface interface,
const MdnsMessage response,
size_t  offset,
const DnsResourceRecord record 
)

Parse a resource record from the Answer Section.

Parameters
[in]interfaceUnderlying network interface
[in]responseIncoming mDNS response message
[in]offsetOffset to first byte of the resource record to be checked
[in]recordPointer to the resource record

Definition at line 1337 of file dns_sd.c.

◆ dnsSdParseNsRecord()

void dnsSdParseNsRecord ( NetInterface interface,
const MdnsMessage query,
size_t  offset,
const DnsResourceRecord record 
)

Parse a resource record from the Authority Section.

Parameters
[in]interfaceUnderlying network interface
[in]queryIncoming mDNS query message
[in]offsetOffset to first byte of the resource record
[in]recordPointer to the resource record

Definition at line 1242 of file dns_sd.c.

◆ dnsSdParseQuestion()

error_t dnsSdParseQuestion ( NetInterface interface,
const MdnsMessage query,
size_t  offset,
const DnsQuestion question,
MdnsMessage response 
)

Parse a question.

Parameters
[in]interfaceUnderlying network interface
[in]queryIncoming mDNS query message
[in]offsetOffset to first byte of the question
[in]questionPointer to the question
[in,out]responsemDNS response message
Returns
Error code

Definition at line 1083 of file dns_sd.c.

◆ dnsSdRegisterService()

error_t dnsSdRegisterService ( DnsSdContext context,
const char_t serviceName,
uint16_t  priority,
uint16_t  weight,
uint16_t  port,
const char_t metadata 
)

Register a DNS-SD service.

Parameters
[in]contextPointer to the DNS-SD context
[in]serviceNameNULL-terminated string that contains the name of the service to be registered
[in]priorityPriority field
[in]weightWeight field
[in]portPort number
[in]metadataNULL-terminated string that contains the discovery-time metadata (TXT record)
Returns
Error code

Definition at line 265 of file dns_sd.c.

◆ dnsSdSendAnnouncement()

error_t dnsSdSendAnnouncement ( DnsSdContext context)

Send announcement packet.

Parameters
[in]contextPointer to the DNS-SD context
Returns
Error code

Definition at line 914 of file dns_sd.c.

◆ dnsSdSendGoodbye()

error_t dnsSdSendGoodbye ( DnsSdContext context,
const DnsSdService service 
)

Send goodbye packet.

Parameters
[in]contextPointer to the DNS-SD context
[in]servicePointer to a DNS-SD service
Returns
Error code

Definition at line 1003 of file dns_sd.c.

◆ dnsSdSendProbe()

error_t dnsSdSendProbe ( DnsSdContext context)

Send probe packet.

Parameters
[in]contextPointer to the DNS-SD context
Returns
Error code

Definition at line 798 of file dns_sd.c.

◆ dnsSdSetInstanceName()

error_t dnsSdSetInstanceName ( DnsSdContext context,
const char_t instanceName 
)

Set service instance name.

Parameters
[in]contextPointer to the DNS-SD context
[in]instanceNameNULL-terminated string that contains the service instance name
Returns
Error code

Definition at line 212 of file dns_sd.c.

◆ dnsSdStart()

error_t dnsSdStart ( DnsSdContext context)

Start mDNS responder.

Parameters
[in]contextPointer to the DNS-SD context
Returns
Error code

Definition at line 126 of file dns_sd.c.

◆ dnsSdStartProbing()

error_t dnsSdStartProbing ( DnsSdContext context)

Restart probing process.

Parameters
[in]contextPointer to the DNS-SD context
Returns
Error code

Definition at line 483 of file dns_sd.c.

◆ dnsSdStop()

error_t dnsSdStop ( DnsSdContext context)

Stop mDNS responder.

Parameters
[in]contextPointer to the DNS-SD context
Returns
Error code

Definition at line 157 of file dns_sd.c.

◆ dnsSdTick()

void dnsSdTick ( DnsSdContext context)

DNS-SD responder timer handler.

This routine must be periodically called by the TCP/IP stack to manage DNS-SD operation

Parameters
[in]contextPointer to the DNS-SD context

Definition at line 506 of file dns_sd.c.

◆ dnsSdUnregisterService()

error_t dnsSdUnregisterService ( DnsSdContext context,
const char_t serviceName 
)

Unregister a DNS-SD service.

Parameters
[in]contextPointer to the DNS-SD context
[in]serviceNameNULL-terminated string that contains the name of the service to be unregistered
Returns
Error code

Definition at line 406 of file dns_sd.c.

Variable Documentation

◆ dnsSdTickCounter

systime_t dnsSdTickCounter

Definition at line 55 of file dns_sd.c.