xref: /illumos-gate/usr/src/man/man9f/net_protocol_walk.9f (revision 8119dad84d6416f13557b0ba8e2aaf9064cbcfd3)
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_PROTOCOL_WALK 9F "May 1, 2008"
NAME
net_protocol_walk - step through the list of registered network protocols
SYNOPSIS
#include <sys/neti.h>

net_data_t *net_protocol_walk(net_data_t net);
INTERFACE LEVEL
illumos DDI specific (illumos DDI).
PARAMETERS
net

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

DESCRIPTION
The net_protocol_walk() function walks through all of the network protocols that have been registered with this interface. The initial call to net_protocol_walk() should be made by passing in NULL as the value for net. When this function returns NULL, the end of the list has been reached.

A caller of net_protocol_walk() is required to walk through the entire list of network protocols, until NULL is returned or, when finished with using the value returned, pass it into a call to net_protocol_release(9F).

RETURN VALUES
The net_protocol_walk() function returns NULL when the end of the list is returned. Otherwise, it returns a non-NULL value as a token for being passed into other function calls within this interface.
CONTEXT
The net_protocol_walk() 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_protocol_lookup (9F), net_protocol_release (9F)