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-dhcp-lease.h"
  30
  31 #include "_sd-common.h"
  32
  33 /*
  34  * A few points:
  35  *
  36  * Instead of returning an empty string array or empty integer array, we
  37  * may return NULL.
  38  *
  39  * Free the data the library returns with libc free(). String arrays
  40  * are NULL terminated, and you need to free the array itself in
  41  * addition to the strings contained.
  42  *
  43  * We return error codes as negative errno, kernel-style. On success, we
  44  * return 0 or positive.
  45  *
  46  * These functions access data in /run. This is a virtual file system;
  47  * therefore, accesses are relatively cheap.
  48  *
  49  * See sd-network(3) for more information.
  50  */
  51
  52 _SD_BEGIN_DECLARATIONS;
  53
  54 /* Get state from ifindex. Possible states: unknown, unmanaged, failed, configuring, configured */
  55 int sd_network_get_link_state(unsigned index, char**state);
  56
  57 /* Get DHCPv4 lease from ifindex. */
  58 int sd_network_get_dhcp_lease(unsigned index, sd_dhcp_lease **ret);
  59
  60 /* Get all network interfaces' indices, and store them in *indices. Returns
  61  * the number of indices. If indices is NULL, only returns the number of indices. */
  62 int sd_network_get_ifindices(unsigned **indices);
  63
  64 /* Monitor object */
  65 typedef struct sd_network_monitor sd_network_monitor;
  66
  67 /* Create a new monitor. Category must be NULL. */
  68 int sd_network_monitor_new(const char *category, sd_network_monitor** ret);
  69
  70 /* Destroys the passed monitor. Returns NULL. */
  71 sd_network_monitor* sd_network_monitor_unref(sd_network_monitor *m);
  72
  73 /* Flushes the monitor */
  74 int sd_network_monitor_flush(sd_network_monitor *m);
  75
  76 /* Get FD from monitor */
  77 int sd_network_monitor_get_fd(sd_network_monitor *m);
  78
  79 /* Get poll() mask to monitor */
  80 int sd_network_monitor_get_events(sd_network_monitor *m);
  81
  82 /* Get timeout for poll(), as usec value relative to CLOCK_MONOTONIC's epoch */
  83 int sd_network_monitor_get_timeout(sd_network_monitor *m, uint64_t *timeout_usec);
  84
  85 _SD_END_DECLARATIONS;
  86
  87 #endif