chiark / gitweb /
sd-network: fix parameter order for sd_network_monitor_new()
[elogind.git] / src / systemd / sd-network.h
index c0b093d..0eaefdc 100644 (file)
@@ -1,7 +1,7 @@
 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
 
-#ifndef foosdloginhfoo
-#define foosdloginhfoo
+#ifndef foosdnetworkhfoo
+#define foosdnetworkhfoo
 
 /***
   This file is part of systemd.
  * may return NULL.
  *
  * Free the data the library returns with libc free(). String arrays
- * are NULL terminated and you need to free the array itself in
+ * are NULL terminated, and you need to free the array itself in
  * addition to the strings contained.
  *
- * We return error codes as negative errno, kernel-style. 0 or
- * positive on success.
+ * We return error codes as negative errno, kernel-style. On success, we
+ * return 0 or positive.
  *
- * These functions access data in /run. This is a virtual file systems,
- * hence the accesses is relatively cheap.
+ * These functions access data in /run. This is a virtual file system;
+ * therefore, accesses are relatively cheap.
  *
  * See sd-network(3) for more information.
  */
 
 _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 index, 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 index, 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 index);
 
 /* Get DHCPv4 lease from ifindex. */
 int sd_network_get_dhcp_lease(unsigned index, sd_dhcp_lease **ret);
 
-/* Get all network interfaces indices, store in *indices. Returns the
- * number of indices. If indices is NULL only returns the number of indices. */
+/* Returns true if link is configured to respect DNS entries received by DHCP */
+int sd_network_dhcp_use_dns(unsigned index);
+
+/* Returns true if link is configured to respect NTP entries received by DHCP */
+int sd_network_dhcp_use_ntp(unsigned index);
+
+/* Get IPv4 DNS entries statically configured for the link */
+int sd_network_get_dns(unsigned index, struct in_addr **addr, size_t *addr_size);
+
+/* Get IPv4 NTP entries statically configured for the link */
+int sd_network_get_ntp(unsigned index, struct in_addr **addr, size_t *addr_size);
+
+/* Get IPv6 DNS entries statically configured for the link */
+int sd_network_get_dns6(unsigned index, struct in6_addr **addr, size_t *addr_size);
+
+/* Get IPv6 NTP entries statically configured for the link */
+int sd_network_get_ntp6(unsigned index, struct in6_addr **addr, size_t *addr_size);
+
+/* 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);
 
 /* Monitor object */
 typedef struct sd_network_monitor sd_network_monitor;
 
-/* Create a new monitor. Category must be NULL. */
-int sd_network_monitor_new(const char *category, sd_network_monitor** ret);
+/* Create a new monitor. Category must be NULL, "links" or "leases". */
+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);