ADC Home > Reference Library > Reference > Darwin > Miscellaneous User Space API Reference

 


DNSServiceDiscovery.h

Includes:
<mach/mach_types.h>
<sys/types.h>
<sys/socket.h>
<sys/cdefs.h>
<netinet/in.h>
<AvailabilityMacros.h>

Introduction



Functions

DNSServiceBrowserCreate
DNSServiceDiscovery_handleReply
DNSServiceDiscoveryDeallocate
DNSServiceDiscoveryMachPort
DNSServiceDomainEnumerationCreate
DNSServiceRegistrationAddRecord
DNSServiceRegistrationCreate
DNSServiceRegistrationRemoveRecord
DNSServiceRegistrationUpdateRecord
DNSServiceResolver_handleReply
DNSServiceResolverResolve

DNSServiceBrowserCreate


dns_service_discovery_ref DNSServiceBrowserCreate ( 
    const char *regtype, 
    const char *domain, 
    DNSServiceBrowserReply callBack, 
    void *context );  
Parameters
regtype
The type of service
domain
The domain in which to find the service
callBack
The function to be called when service instances are found or removed
context
A user specified context which will be passed to the callout function.
Return Value

A dns_registration_t

Discussion

@description Asynchronously create a DNS Service browser

Availability
Introduced in Mac OS X v10.2, and deprecated in Mac OS X v10.2.

DNSServiceDiscovery_handleReply


void DNSServiceDiscovery_handleReply(
    void *replyMsg);  
Parameters
replyMsg
The Mach message.
Discussion

@description This function should be called with the Mach message sent to the port returned by the call to DNSServiceResolverResolve. The reply message will be interpreted and will result in a call to the specified callout function.


DNSServiceDiscoveryDeallocate


void DNSServiceDiscoveryDeallocate(
    dns_service_discovery_ref dnsServiceDiscovery);  
Parameters
dnsServiceDiscovery
A dns_service_discovery_ref as returned from a creation or enumeration call
Return Value

void

Discussion

@description Deallocates the DNS Service Discovery type / closes the connection to the server

Availability
Introduced in Mac OS X v10.2, and deprecated in Mac OS X v10.2.

DNSServiceDiscoveryMachPort


mach_port_t DNSServiceDiscoveryMachPort(
    dns_service_discovery_ref dnsServiceDiscovery);  
Parameters
registration
A dns_service_discovery_ref as returned from DNSServiceRegistrationCreate
Return Value

A mach reply port which will be sent messages as appropriate. These messages should be passed to the DNSServiceDiscovery_handleReply function. A NULL value indicates that no address was specified or some other error occurred which prevented the resolution from being started.

Discussion

@description Returns the mach port for a dns_service_discovery_ref

Availability
Introduced in Mac OS X v10.2, and deprecated in Mac OS X v10.2.

DNSServiceDomainEnumerationCreate


dns_service_discovery_ref DNSServiceDomainEnumerationCreate ( 
    int registrationDomains, 
    DNSServiceDomainEnumerationReply callBack, 
    void *context );  
Parameters
registrationDomains
A boolean indicating whether you are looking for recommended registration domains (e.g. equivalent to the AppleTalk zone list in the AppleTalk Control Panel) or recommended browsing domains (e.g. equivalent to the AppleTalk zone list in the Chooser).
callBack
The function to be called when domains are found or removed
context
A user specified context which will be passed to the callout function.
Return Value

A dns_registration_t

Discussion

@description Asynchronously create a DNS Domain Enumerator

Availability
Introduced in Mac OS X v10.2, and deprecated in Mac OS X v10.2.

DNSServiceRegistrationAddRecord


DNSRecordReference DNSServiceRegistrationAddRecord(
    dns_service_discovery_ref dnsServiceDiscovery,
    uint16_t rrtype,
    uint16_t rdlen,
    const char *rdata,
    uint32_t ttl) ;  
Parameters
dnsServiceDiscovery
A dns_service_discovery_ref as returned from a DNSServiceRegistrationCreate call
rrtype
A standard DNS Resource Record Type, from http://www.iana.org/assignments/dns-parameters
rdlen
Length of the data
rdata
Opaque binary Resource Record data, up to 64 kB.
ttl
time to live for the added record.
Return Value

DNSRecordReference An opaque reference that can be passed to the update and remove record calls. If an error occurs, this value will be zero or negative

Discussion

@description Request that the mDNS Responder add the DNS Record of a specific type

Availability
Introduced in Mac OS X v10.2, and deprecated in Mac OS X v10.2.

DNSServiceRegistrationCreate


dns_service_discovery_ref DNSServiceRegistrationCreate ( 
    const char *name, 
    const char *regtype, 
    const char *domain, 
    uint16_t port, 
    const char *txtRecord, 
    DNSServiceRegistrationReply callBack, 
    void *context );  
Parameters
name
The name of this service instance (e.g. "Steve's Printer")
regtype
The service type (e.g. "_printer._tcp." -- see RFC 2782 (DNS SRV) and )
domain
The domain in which to register the service (e.g. "apple.com.")
port
The local port on which this service is being offered (in network byte order)
txtRecord
Optional protocol-specific additional information
callBack
The DNSServiceRegistrationReply function to be called
context
A user specified context which will be passed to the callout function.
Return Value

A dns_registration_t

Discussion

@description Register a named service with DNS Service Discovery

Availability
Introduced in Mac OS X v10.2, and deprecated in Mac OS X v10.2.

DNSServiceRegistrationRemoveRecord


DNSServiceRegistrationReplyErrorType DNSServiceRegistrationRemoveRecord(
    dns_service_discovery_ref ref,
    DNSRecordReference reference) ;  
Parameters
dnsServiceDiscovery
A dns_service_discovery_ref as returned from a DNSServiceRegistrationCreate call
dnsRecordReference
A dnsRecordReference as returned from a DNSServiceRegistrationAddRecord call
Return Value

DNSServiceRegistrationReplyErrorType If an error occurs, this value will be non zero

Discussion

@description Request that the mDNS Responder remove the DNS Record(s) of a specific type

Availability
Introduced in Mac OS X v10.2, and deprecated in Mac OS X v10.2.

DNSServiceRegistrationUpdateRecord


DNSServiceRegistrationReplyErrorType DNSServiceRegistrationUpdateRecord(
    dns_service_discovery_ref ref,
    DNSRecordReference reference,
    uint16_t rdlen,
    const char *rdata,
    uint32_t ttl) ;  
Parameters
dnsServiceDiscovery
A dns_service_discovery_ref as returned from a DNSServiceRegistrationCreate call
dnsRecordReference
A dnsRecordReference as returned from a DNSServiceRegistrationAddRecord call
rdlen
Length of the data
rdata
Opaque binary Resource Record data, up to 64 kB.
ttl
time to live for the updated record.
Return Value

DNSServiceRegistrationReplyErrorType If an error occurs, this value will be non zero

Discussion

@description Request that the mDNS Responder add the DNS Record of a specific type

Availability
Introduced in Mac OS X v10.2, and deprecated in Mac OS X v10.2.

DNSServiceResolver_handleReply


void DNSServiceDiscovery_handleReply(
    void *replyMsg);  
Parameters
replyMsg
The Mach message.
Discussion

@description This function should be called with the Mach message sent to the port returned by the call to DNSServiceResolverResolve. The reply message will be interpreted and will result in a call to the specified callout function.


DNSServiceResolverResolve


dns_service_discovery_ref DNSServiceResolverResolve ( 
    const char *name, 
    const char *regtype, 
    const char *domain, 
    DNSServiceResolverReply callBack, 
    void *context );  
Parameters
name
The name of the service instance
regtype
The type of service
domain
The domain in which to find the service
callBack
The DNSServiceResolverReply function to be called when the specified address has been resolved.
context
A user specified context which will be passed to the callout function.
Return Value

A dns_registration_t

Discussion

@description Resolved a named instance of a service to its address, port, and (optionally) other demultiplexing information contained in the TXT record.

Availability
Introduced in Mac OS X v10.2, and deprecated in Mac OS X v10.2.


Did this document help you?
Yes: Tell us what works for you.
It’s good, but: Report typos, inaccuracies, and so forth.
It wasn’t helpful: Tell us what would have helped.
Last Updated: 2006-06-20