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 dstaddress; /* Destination address
59
(point-to-point only). */
60
isc_uint32_t flags; /* Flags; see below. */
63
/* Interface flags. */
65
#define INTERFACE_F_UP 0x00000001U
66
#define INTERFACE_F_POINTTOPOINT 0x00000002U
67
#define INTERFACE_F_LOOPBACK 0x00000004U
76
isc_interfaceiter_create(isc_mem_t *mctx, isc_interfaceiter_t **iterp);
78
* Create an iterator for traversing the operating system's list
79
* of network interfaces.
84
* Various network-related errors
88
isc_interfaceiter_first(isc_interfaceiter_t *iter);
90
* Position the iterator on the first interface.
93
* ISC_R_SUCCESS Success.
94
* ISC_R_NOMORE There are no interfaces.
98
isc_interfaceiter_current(isc_interfaceiter_t *iter,
99
isc_interface_t *ifdata);
101
* Get information about the interface the iterator is currently
102
* positioned at and store it at *ifdata.
105
* The iterator has been successfully positioned using
106
* isc_interface_iter_first() / isc_interface_iter_next().
109
* ISC_R_SUCCESS Success.
113
isc_interfaceiter_next(isc_interfaceiter_t *iter);
115
* Position the iterator on the next interface.
118
* The iterator has been successfully positioned using
119
* isc_interface_iter_first() / isc_interface_iter_next().
122
* ISC_R_SUCCESS Success.
123
* ISC_R_NOMORE There are no more interfaces.
127
isc_interfaceiter_destroy(isc_interfaceiter_t **iterp);
129
* Destroy the iterator.
134
#endif /* ISC_INTERFACEITER_H */
added
removed
include/interfaceiter.h
