sd-network.h revision deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen This file is part of systemd.
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen Copyright 2011 Lennart Poettering
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen Copyright 2014 Tom Gundersen
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen systemd is free software; you can redistribute it and/or modify it
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen under the terms of the GNU Lesser General Public License as published by
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen the Free Software Foundation; either version 2.1 of the License, or
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen (at your option) any later version.
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen systemd is distributed in the hope that it will be useful, but
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen WITHOUT ANY WARRANTY; without even the implied warranty of
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen Lesser General Public License for more details.
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen You should have received a copy of the GNU Lesser General Public License
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen along with systemd; If not, see <http://www.gnu.org/licenses/>.
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen * A few points:
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen * Instead of returning an empty string array or empty integer array, we
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen * may return NULL.
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen * Free the data the library returns with libc free(). String arrays
10b17992ee59ac1d03d6fc210a976bc2b59f6d75Jason St. John * are NULL terminated, and you need to free the array itself in
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen * addition to the strings contained.
10b17992ee59ac1d03d6fc210a976bc2b59f6d75Jason St. John * We return error codes as negative errno, kernel-style. On success, we
10b17992ee59ac1d03d6fc210a976bc2b59f6d75Jason St. John * return 0 or positive.
10b17992ee59ac1d03d6fc210a976bc2b59f6d75Jason St. John * These functions access data in /run. This is a virtual file system;
10b17992ee59ac1d03d6fc210a976bc2b59f6d75Jason St. John * therefore, accesses are relatively cheap.
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen * See sd-network(3) for more information.
deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044Tom Gundersen/* Get state from ifindex.
deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044Tom Gundersen * Possible states: failed, configuring, configured
deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044Tom Gundersen * Possible return codes:
deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044Tom Gundersen * -ENODATA: networkd is not aware of the link
deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044Tom Gundersen * -EUNATCH: networkd is not managing this link
deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044Tom Gundersen * -EBUSY: udev is still processing the link, networkd does not yet know if it will manage it
deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044Tom Gundersenint sd_network_get_link_state(unsigned index, char **state);
deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044Tom Gundersen/* Get operatinal state from ifindex.
deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044Tom Gundersen * Possible states: unknown, dormant, carrier
deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044Tom Gundersen * Possible return codes:
deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044Tom Gundersen * -ENODATA: networkd is not aware of the link
deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044Tom Gundersenint sd_network_get_link_operational_state(unsigned index, char **state);
deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044Tom Gundersen/* Returns true if link exists and is loopback, and false otherwise */
deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044Tom Gundersenint sd_network_link_is_loopback(unsigned index);
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen/* Get DHCPv4 lease from ifindex. */
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersenint sd_network_get_dhcp_lease(unsigned index, sd_dhcp_lease **ret);
10b17992ee59ac1d03d6fc210a976bc2b59f6d75Jason St. John/* Get all network interfaces' indices, and store them in *indices. Returns
10b17992ee59ac1d03d6fc210a976bc2b59f6d75Jason St. John * the number of indices. If indices is NULL, only returns the number of indices. */
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersenint sd_network_get_ifindices(unsigned **indices);
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen/* Monitor object */
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersentypedef struct sd_network_monitor sd_network_monitor;
7e141e498c73ec7c8b61a0df37c4937f1d6becc7Tom Gundersen/* Create a new monitor. Category must be NULL, "links" or "leases". */
deb2e5230b4dcbc0e2e02cc47a0b2d0d7179a044Tom Gundersenint sd_network_monitor_new(const char *category, sd_network_monitor **ret);
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen/* Destroys the passed monitor. Returns NULL. */
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersensd_network_monitor* sd_network_monitor_unref(sd_network_monitor *m);
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen/* Flushes the monitor */
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersenint sd_network_monitor_flush(sd_network_monitor *m);
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen/* Get FD from monitor */
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersenint sd_network_monitor_get_fd(sd_network_monitor *m);
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen/* Get poll() mask to monitor */
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersenint sd_network_monitor_get_events(sd_network_monitor *m);
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen/* Get timeout for poll(), as usec value relative to CLOCK_MONOTONIC's epoch */