sd-network: rename "index" parameter to "ifindex"

[elogind.git] / src / systemd / sd-network.h

diff --git a/src/systemd/sd-network.h b/src/systemd/sd-network.h
index 9562b78feba12a732680ab1384f198caed56416c..45fd3ce08ea0c93aec6b3b6319d220b4004bf7d4 100644 (file)
--- a/src/systemd/sd-network.h
+++ b/src/systemd/sd-network.h
@@ -51,21 +51,62 @@
 
 _SD_BEGIN_DECLARATIONS;
 
 
 _SD_BEGIN_DECLARATIONS;
 

-/* Get state from ifindex. Possible states: unknown, unmanaged, failed, configuring, configured */
-int sd_network_get_link_state(unsigned index, char**state);
+/* Get state from ifindex.
+ * Possible states: failed, configuring, configured
+ * Possible return codes:
+ *   -ENODATA: networkd is not aware of the link
+ *   -EUNATCH: networkd is not managing this link
+ *   -EBUSY: udev is still processing the link, networkd does not yet know if it will manage it
+ */
+int sd_network_get_link_state(unsigned ifindex, char **state);
+
+/* Get operatinal state from ifindex.
+ * Possible states: unknown, dormant, carrier, degraded, routable
+ * Possible return codes:
+ *   -ENODATA: networkd is not aware of the link
+ */
+int sd_network_get_link_operational_state(unsigned ifindex, char **state);
+
+/* Get overall opeartional state
+ * Possible states: unknown, dormant, carrier, degraded, routable
+ * Possible return codes:
+ *   -ENODATA: networkd is not aware of any links
+ */
+int sd_network_get_operational_state(char **state);
+
+/* Returns true if link exists and is loopback, and false otherwise */
+int sd_network_link_is_loopback(unsigned ifindex);

 
 /* Get DHCPv4 lease from ifindex. */
 
 /* Get DHCPv4 lease from ifindex. */

-int sd_network_get_dhcp_lease(unsigned index, sd_dhcp_lease **ret);
+int sd_network_get_dhcp_lease(unsigned ifindex, sd_dhcp_lease **ret);
+
+/* Returns true if link is configured to respect DNS entries received by DHCP */
+int sd_network_dhcp_use_dns(unsigned ifindex);
+
+/* Returns true if link is configured to respect NTP entries received by DHCP */
+int sd_network_dhcp_use_ntp(unsigned ifindex);
+
+/* Get IPv4 DNS entries statically configured for the link */
+int sd_network_get_dns(unsigned ifindex, struct in_addr **addr);
+
+/* Get IPv4 NTP entries statically configured for the link */
+int sd_network_get_ntp(unsigned ifindex, struct in_addr **addr);
+
+/* Get IPv6 DNS entries statically configured for the link */
+int sd_network_get_dns6(unsigned ifindex, struct in6_addr **addr);
+
+/* Get IPv6 NTP entries statically configured for the link */
+int sd_network_get_ntp6(unsigned ifindex, struct in6_addr **addr);

 
 /* Get all network interfaces' indices, and store them in *indices. Returns
  * the number of indices. If indices is NULL, only returns the number of indices. */
 
 /* Get all network interfaces' indices, and store them in *indices. Returns
  * the number of indices. If indices is NULL, only returns the number of indices. */

-int sd_network_get_ifindices(unsigned **indices);
+int sd_network_get_ifindices(unsigned **ifindices);

 
 /* Monitor object */
 typedef struct sd_network_monitor sd_network_monitor;
 
 /* Create a new monitor. Category must be NULL, "links" or "leases". */
 
 /* Monitor object */
 typedef struct sd_network_monitor sd_network_monitor;
 
 /* Create a new monitor. Category must be NULL, "links" or "leases". */

-int sd_network_monitor_new(const char *category, sd_network_monitor** ret);
+int sd_network_monitor_new(sd_network_monitor **ret, const char *category);

 
 /* Destroys the passed monitor. Returns NULL. */
 sd_network_monitor* sd_network_monitor_unref(sd_network_monitor *m);
 
 /* Destroys the passed monitor. Returns NULL. */
 sd_network_monitor* sd_network_monitor_unref(sd_network_monitor *m);