2 * Copyright (C) 1999-2001 Internet Software Consortium.
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
9 * DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
10 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
11 * INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
13 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
14 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
15 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: interfaceiter.h,v 1.10 2001/01/09 21:57:01 bwelling Exp $ */
20 #ifndef ISC_INTERFACEITER_H
21 #define ISC_INTERFACEITER_H 1
30 * Iterate over the list of network interfaces.
32 * Interfaces whose address family is not supported are ignored and never
33 * returned by the iterator. Interfaces whose netmask, interface flags,
34 * or similar cannot be obtained are also ignored, and the failure is logged.
37 * The API for scanning varies greatly among operating systems.
38 * This module attempts to hide the differences.
46 #include <isc/netaddr.h>
47 #include <isc/types.h>
50 * Public structure describing a network interface.
53 struct isc_interface {
54 char name[32]; /* Interface name, null-terminated. */
55 unsigned int af; /* Address family. */
56 isc_netaddr_t address; /* Local address. */
57 isc_netaddr_t netmask; /* Network mask. */
58 isc_netaddr_t broadcast; /* Broadcast address. */
59 isc_netaddr_t dstaddress; /* Destination address
60 (point-to-point only). */
61 isc_uint32_t flags; /* Flags; see below. */
62 unsigned int ifindex; /* Interface Index */
63 unsigned int scopeid; /* Scope id for Multicasting */
66 /* Interface flags. */
68 #define INTERFACE_F_UP 0x00000001U /* Interface is up */
69 #define INTERFACE_F_POINTTOPOINT 0x00000002U /*this is point-to-point interface*/
70 #define INTERFACE_F_LOOPBACK 0x00000004U /* this is loopback interface */
71 #define INTERFACE_F_BROADCAST 0x00000008U /* Broadcast is supported */
72 #define INTERFACE_F_MULTICAST 0x00000010U /* multicast is supported */
81 isc_interfaceiter_create(isc_mem_t *mctx, isc_interfaceiter_t **iterp);
83 * Create an iterator for traversing the operating system's list
84 * of network interfaces.
89 * Various network-related errors
93 isc_interfaceiter_first(isc_interfaceiter_t *iter);
95 * Position the iterator on the first interface.
98 * ISC_R_SUCCESS Success.
99 * ISC_R_NOMORE There are no interfaces.
103 isc_interfaceiter_current(isc_interfaceiter_t *iter,
104 isc_interface_t *ifdata);
106 * Get information about the interface the iterator is currently
107 * positioned at and store it at *ifdata.
110 * The iterator has been successfully positioned using
111 * isc_interface_iter_first() / isc_interface_iter_next().
114 * ISC_R_SUCCESS Success.
118 isc_interfaceiter_next(isc_interfaceiter_t *iter);
120 * Position the iterator on the next interface.
123 * The iterator has been successfully positioned using
124 * isc_interface_iter_first() / isc_interface_iter_next().
127 * ISC_R_SUCCESS Success.
128 * ISC_R_NOMORE There are no more interfaces.
132 isc_interfaceiter_destroy(isc_interfaceiter_t **iterp);
134 * Destroy the iterator.
139 #endif /* ISC_INTERFACEITER_H */