share/man/man9f/net_protocol_walk.9f

   1 '\" te
   2 .\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH NET_PROTOCOL_WALK 9F "May 1, 2008"
   7 .SH NAME
   8 net_protocol_walk \- step through the list of registered network protocols
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/neti.h>
  13
  14 \fBnet_data_t\fR *\fBnet_protocol_walk\fR(\fBnet_data_t\fR \fInet\fR);
  15 .fi
  16
  17 .SH INTERFACE LEVEL
  18 .sp
  19 .LP
  20 Solaris DDI specific (Solaris DDI).
  21 .SH PARAMETERS
  22 .sp
  23 .ne 2
  24 .na
  25 \fB\fInet\fR\fR
  26 .ad
  27 .RS 7n
  28 value returned from a successful call to \fBnet_protocol_lookup\fR(9F).
  29 .RE
  30
  31 .SH DESCRIPTION
  32 .sp
  33 .LP
  34 The \fBnet_protocol_walk()\fR function walks through all of the network
  35 protocols that have been registered with this interface. The initial call to
  36 \fBnet_protocol_walk()\fR should be made by passing in \fBNULL\fR as the value
  37 for \fInet\fR. When this function returns \fBNULL\fR, the end of the list has
  38 been reached.
  39 .sp
  40 .LP
  41 A caller of \fBnet_protocol_walk()\fR is required to walk through the entire
  42 list of network protocols, until \fBNULL\fR is returned or, when finished with
  43 using the value returned, pass it into a call to
  44 \fBnet_protocol_release\fR(9F).
  45 .SH RETURN VALUES
  46 .sp
  47 .LP
  48 The \fBnet_protocol_walk()\fR function returns \fBNULL\fR when the end of the
  49 list is returned. Otherwise, it returns a non-\fBNULL\fR value as a token for
  50 being passed into other function calls within this interface.
  51 .SH CONTEXT
  52 .sp
  53 .LP
  54 The \fBnet_protocol_walk()\fR function may be called from user,  kernel, or
  55 interrupt context.
  56 .SH ATTRIBUTES
  57 .sp
  58 .LP
  59 See \fBattributes\fR(5) for descriptions of the following attributes:
  60 .sp
  61
  62 .sp
  63 .TS
  64 box;
  65 c | c
  66 l | l .
  67 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  68 _
  69 Interface Stability     Committed
  70 .TE
  71
  72 .SH SEE ALSO
  73 .sp
  74 .LP
  75 \fBnet_protocol_lookup\fR(9F), \fBnet_protocol_release\fR(9F),
  76 \fBattributes\fR(5)