mDNS
mDNS functions More...
Modules |
|
Types | |
mDNS data types
|
|
Functions |
|
mdns_service_details_t | gos_mdns_setup_service_details ( gos_mdns_service_details_t *service_details, const char *service_name, const char *instance_name, uint16_t port, uint16_t priority, uint16_t weight, uint16_t ttl, const char *txt_buffer, uint16_t max_txt_size) |
populates
mdns_service_details_t
structure with parameters.
More...
|
|
mdns_service_handle_t | gos_mdns_service_register ( gos_interface_t interface, gos_mdns_service_details_t *service_details) |
Register an mDNS service.
More...
|
|
gos_result_t | gos_mdns_service_unregister ( mdns_service_handle_t service_handle) |
Unregister an mDNS service.
More...
|
|
Detailed Description
mDNS functions
Function Documentation
◆ gos_mdns_service_register()
mdns_service_handle_t gos_mdns_service_register | ( | gos_interface_t |
interface,
|
gos_mdns_service_details_t * |
service_details
|
||
) |
Register an mDNS service.
This registers an mDNS service
- Parameters
-
interface
gos_interface_t service_details
gos_mdns_service_details_t
- Returns
- mdns_service_handle_t the service handle
◆ gos_mdns_service_unregister()
gos_result_t gos_mdns_service_unregister | ( | mdns_service_handle_t |
service_handle
|
) |
Unregister an mDNS service.
This unregisters an mDNS service previously registered with gos_mdns_service_register()
- Parameters
-
service_handle
service handle returned by gos_mdns_service_register() when service was registered
- Returns
- gos_result_t the result of unregistering the service
◆ gos_mdns_setup_service_details()
mdns_service_details_t gos_mdns_setup_service_details | ( | gos_mdns_service_details_t * |
service_details,
|
const char * |
service_name,
|
||
const char * |
instance_name,
|
||
uint16_t |
port,
|
||
uint16_t |
priority,
|
||
uint16_t |
weight,
|
||
uint16_t |
ttl,
|
||
const char * |
txt_buffer,
|
||
uint16_t |
max_txt_size
|
||
) |
populates mdns_service_details_t structure with parameters.
This function formats the parameters required for mDNS and populates the service details, so that gos_mdns_service_register can be called
- Parameters
-
service_details
gos_mdns_service_details_t service_name
mDNS service name - must end with .local instance_name
name of the service instannce port
The TCP or UDP port on which the service is to be found. priority
The priority of the target host, lower value means more preferred weight
A relative weight for records with the same priority, higher value means more preferred ttl
Time to live, period of caching of the resource records txt_buffer
buffer for storing txt data max_txt_size
legnth of txt_buffer
- Returns
- gos_result_t the result of gos_mdns_setup_service_details()