xref: /illumos-gate/usr/src/man/man9f/net_phygetnext.9f (revision 37e2cd25d56b334a2403f2540a0b0a1e6a40bcd1)
te
Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
NET_PHYGETNEXT 9F "May 1, 2008"
NAME
net_phygetnext - search through the current list of network interfaces
SYNOPSIS
#include <sys/neti.h>

phy_if_t net_phygetnext(const net_data_t net, const phy_if_t ifp);
INTERFACE LEVEL
illumos DDI specific (illumos DDI).
PARAMETERS
net

value returned from a successful call to net_protocol_lookup(9F).

ifp

value returned from a successful call to this function or net_phylookup(9F).

DESCRIPTION
The net_phygetnext() function searches through all of the network interfaces that a network protocol "owns". To start searching through all of the interfaces owned by a protocol, a value of 0 should be passed through as the value of ifp. When 0 is returned by this function, the last of the interfaces owned by this protocol has been reached.

When called successfully, the value returned represents a network interface that exists, at the time of the call, within the scope of the network interface. This value is only guaranteed to be unique for a name within the scope of the network protocol.

EXAMPLES
 net_data_t net;
 phy_if_t ifp;
 char buffer[32];

 net = net_protocol_lookup("inet");

 if (net != NULL) {
 for (ifp = net_phygetnext(net, 0); ifp != 0;
 ifp = net_phygetnext(net, ifp)) {
 /* Do something with ifp */
 if (net_getifname(net, ifp, buffer,
 sizeof(buffer) >= 0)
 printf("Interface %s0, buffer);
 }
 }
RETURN VALUES
The net_phygetnext() function returns -1 if it is not supported by the network protocol or 0 if an attempt to go beyond the last network interface is made. Otherwise, it returns a value representing a network interface.
CONTEXT
The net_phygetnext() function may be called from user, kernel, or interrupt context.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
SEE ALSO
attributes (7), net_phylookup (9F), net_protocol_lookup (9F)