nut/docs/man/nutscan_scan_avahi.txt

53 lines
1.4 KiB
Text
Raw Normal View History

2011-09-29 18:14:46 +00:00
NUTSCAN_SCAN_AVAHI(3)
=====================
NAME
----
2012-08-12 21:39:31 +00:00
nutscan_scan_avahi - Scan network for NUT services via mDNS
2011-09-29 18:14:46 +00:00
SYNOPSIS
--------
#include <nut-scan.h>
2022-06-29 10:37:36 +00:00
#include <unistd.h> /* useconds_t */
2011-09-29 18:14:46 +00:00
2022-06-29 10:37:36 +00:00
nutscan_device_t * nutscan_scan_avahi(useconds_t usec_timeout);
2011-09-29 18:14:46 +00:00
DESCRIPTION
-----------
2022-06-29 10:37:36 +00:00
The *nutscan_scan_avahi()* function tries to detect the NUT service via
mDNS, and its associated devices. It uses the Avahi library to do so.
2011-09-29 18:14:46 +00:00
2012-01-24 10:22:33 +00:00
You MUST call linkman:nutscan_init[3] before using this function.
2022-06-29 10:37:36 +00:00
This function can query perspective IP addresses using NUT protocol, and
in this case it waits up to 'usec_timeout' microseconds before considering
an IP address to be unresponsive.
2011-09-29 18:14:46 +00:00
RETURN VALUE
------------
2022-06-29 10:37:36 +00:00
The *nutscan_scan_avahi()* function returns a pointer to a
`nutscan_device_t` structure containing all found devices.
It returns NULL if an error occurs, or if no device is found.
2011-09-29 18:14:46 +00:00
SEE ALSO
--------
2022-06-29 10:37:36 +00:00
2012-01-24 10:22:33 +00:00
linkman:nutscan_init[3],
2022-06-29 10:37:36 +00:00
linkman:nutscan_scan_usb[3], linkman:nutscan_scan_xml_http_range[3],
linkman:nutscan_scan_nut[3], linkman:nutscan_scan_snmp[3],
linkman:nutscan_scan_ipmi[3], linkman:nutscan_display_ups_conf[3],
2011-09-29 18:14:46 +00:00
linkman:nutscan_display_parsable[3], linkman:nutscan_new_device[3],
linkman:nutscan_free_device[3], linkman:nutscan_add_option_to_device[3],
2012-08-12 21:39:31 +00:00
linkman:nutscan_add_device_to_device[3], linkman:nutscan_cidr_to_ip[3],
2022-06-29 10:37:36 +00:00
linkman:nutscan_scan_eaton_serial[3]
Internet resources:
~~~~~~~~~~~~~~~~~~~
2012-08-12 21:39:31 +00:00
http://avahi.org/