src/systemd/sd-network.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foosdnetworkhfoo
   4 #define foosdnetworkhfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2011 Lennart Poettering
  10   Copyright 2014 Tom Gundersen
  11
  12   systemd is free software; you can redistribute it and/or modify it
  13   under the terms of the GNU Lesser General Public License as published by
  14   the Free Software Foundation; either version 2.1 of the License, or
  15   (at your option) any later version.
  16
  17   systemd is distributed in the hope that it will be useful, but
  18   WITHOUT ANY WARRANTY; without even the implied warranty of
  19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20   Lesser General Public License for more details.
  21
  22   You should have received a copy of the GNU Lesser General Public License
  23   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  24 ***/
  25
  26 #include <sys/types.h>
  27 #include <inttypes.h>
  28
  29 #include "_sd-common.h"
  30
  31 /*
  32  * A few points:
  33  *
  34  * Instead of returning an empty string array or empty integer array, we
  35  * may return NULL.
  36  *
  37  * Free the data the library returns with libc free(). String arrays
  38  * are NULL terminated, and you need to free the array itself in
  39  * addition to the strings contained.
  40  *
  41  * We return error codes as negative errno, kernel-style. On success, we
  42  * return 0 or positive.
  43  *
  44  * These functions access data in /run. This is a virtual file system;
  45  * therefore, accesses are relatively cheap.
  46  *
  47  * See sd-network(3) for more information.
  48  */
  49
  50 _SD_BEGIN_DECLARATIONS;
  51
  52 /* Get overall operational state
  53  * Possible states: down, up, dormant, carrier, degraded, routable
  54  * Possible return codes:
  55  *   -ENODATA: networkd is not aware of any links
  56  */
  57 int sd_network_get_operational_state(char **state);
  58
  59 /* Get DNS entries for all links. These are string representations of
  60  * IP addresses */
  61 int sd_network_get_dns(char ***addr);
  62
  63 /* Get NTP entries for all links. These are domain names or string
  64  * reperesentations of IP addresses */
  65 int sd_network_get_ntp(char ***addr);
  66
  67 /* Get state from ifindex.
  68  * Possible states:
  69  *   pending: udev is still processing the link, we don't yet know if we will manage it
  70  *   failed: networkd failed to manage the link
  71  *   configuring: in the process of retrieving configuration or configuring the link
  72  *   configured: link configured successfully
  73  *   unmanaged: networkd is not handling the link
  74  *   linger: the link is gone, but has not yet been dropped by networkd
  75  * Possible return codes:
  76  *   -ENODATA: networkd is not aware of the link
  77  */
  78 int sd_network_get_link_state(int ifindex, char **state);
  79
  80 /* Get operatinal state from ifindex.
  81  * Possible states: down, up, dormant, carrier, degraded, routable
  82  * Possible return codes:
  83  *   -ENODATA: networkd is not aware of the link
  84  */
  85 int sd_network_get_link_operational_state(int ifindex, char **state);
  86
  87 /* Get DNS entries for a given link. These are string representations of
  88  * IP addresses */
  89 int sd_network_get_link_dns(int ifindex, char ***addr);
  90
  91 /* Get NTP entries for a given link. These are domain names or string
  92  * reperesentations of IP addresses */
  93 int sd_network_get_link_ntp(int ifindex, char ***addr);
  94
  95 /* Indicates whether or not LLMNR should be enabled for the link
  96  * Possible levels of support: yes, no, resolve
  97  * Possible return codes:
  98  *   -ENODATA: networkd is not aware of the link*/
  99 int sd_network_get_link_llmnr(int ifindex, char **llmnr);
 100
 101 /* Monitor object */
 102 typedef struct sd_network_monitor sd_network_monitor;
 103
 104 /* Create a new monitor. Category must be NULL, "links" or "leases". */
 105 int sd_network_monitor_new(sd_network_monitor **ret, const char *category);
 106
 107 /* Destroys the passed monitor. Returns NULL. */
 108 sd_network_monitor* sd_network_monitor_unref(sd_network_monitor *m);
 109
 110 /* Flushes the monitor */
 111 int sd_network_monitor_flush(sd_network_monitor *m);
 112
 113 /* Get FD from monitor */
 114 int sd_network_monitor_get_fd(sd_network_monitor *m);
 115
 116 /* Get poll() mask to monitor */
 117 int sd_network_monitor_get_events(sd_network_monitor *m);
 118
 119 /* Get timeout for poll(), as usec value relative to CLOCK_MONOTONIC's epoch */
 120 int sd_network_monitor_get_timeout(sd_network_monitor *m, uint64_t *timeout_usec);
 121
 122 _SD_END_DECLARATIONS;
 123
 124 #endif