sd-networkd: rename link_get_state to link_get_setup_state

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

diff --git a/src/systemd/sd-network.h b/src/systemd/sd-network.h
index 14373c7c965dc8c8181847a48d853888ecf61943..47731c2620cf4a75bf011b8964543c040deaa8d6 100644 (file)
--- a/src/systemd/sd-network.h
+++ b/src/systemd/sd-network.h
@@ -64,34 +64,45 @@ int sd_network_get_dns(char ***addr);
  * reperesentations of IP addresses */
 int sd_network_get_ntp(char ***addr);
 
-/* Get state from ifindex.
- * Possible states: failed, configuring, configured, unmanaged
+/* Get setup state from ifindex.
+ * Possible states:
+ *   pending: udev is still processing the link, we don't yet know if we will manage it
+ *   failed: networkd failed to manage the link
+ *   configuring: in the process of retrieving configuration or configuring the link
+ *   configured: link configured successfully
+ *   unmanaged: networkd is not handling the link
+ *   linger: the link is gone, but has not yet been dropped by networkd
  * Possible return codes:
  *   -ENODATA: networkd is not aware of the link
- *   -EBUSY: udev is still processing the link, networkd does not yet know if it will manage it
  */
-int sd_network_get_link_state(int ifindex, char **state);
+int sd_network_link_get_setup_state(int ifindex, char **state);
 
 /* Get operatinal state from ifindex.
- * Possible states: unknown, dormant, carrier, degraded, routable
+ * Possible states:
+ *   off: the device is powered down
+ *   no-carrier: the device is powered up, but it does not yet have a carrier
+ *   dormant: the device has a carrier, but is not yet ready for normal traffic
+ *   carrier: the link has a carrier
+ *   degraded: the link has carrier and addresses valid on the local link configured
+ *   routable: the link has carrier and routable address configured
  * Possible return codes:
  *   -ENODATA: networkd is not aware of the link
  */
-int sd_network_get_link_operational_state(int ifindex, char **state);
+int sd_network_link_get_operational_state(int ifindex, char **state);
 
 /* Get DNS entries for a given link. These are string representations of
  * IP addresses */
-int sd_network_get_link_dns(int ifindex, char ***addr);
+int sd_network_link_get_dns(int ifindex, char ***addr);
 
 /* Get NTP entries for a given link. These are domain names or string
  * reperesentations of IP addresses */
-int sd_network_get_link_ntp(int ifindex, char ***addr);
+int sd_network_link_get_ntp(int ifindex, char ***addr);
 
 /* Indicates whether or not LLMNR should be enabled for the link
  * Possible levels of support: yes, no, resolve
  * Possible return codes:
  *   -ENODATA: networkd is not aware of the link*/
-int sd_network_get_link_llmnr(int ifindex, char **llmnr);
+int sd_network_link_get_llmnr(int ifindex, char **llmnr);
 
 /* Monitor object */
 typedef struct sd_network_monitor sd_network_monitor;