usr/src/man/man9f/net_protocol_lookup.9f

   1 '\" te
   2 .\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright (C) 2012, Joyent, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH NET_PROTOCOL_LOOKUP 9F "Mar 5, 2012"
   8 .SH NAME
   9 net_protocol_lookup \- locate an implementation of a network layer protocol
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/neti.h>
  14
  15 \fBnet_handle_t\fR \fBnet_protocol_lookup\fR(\fBnetid_t\fR \fIid\fR, \fBconst\fR \fBchar\fR *\fIprotocol\fR);
  16 .fi
  17
  18 .SH INTERFACE LEVEL
  19 .sp
  20 .LP
  21 Solaris DDI specific (Solaris DDI).
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIid\fR\fR
  27 .ad
  28 .RS 10n
  29 network instance identifier.
  30 .RE
  31
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIfamily\fR\fR
  36 .ad
  37 .RS 10n
  38 name of the network protocol to find.
  39 .RE
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 The \fBnet_protocol_lookup()\fR function attempts to locate a data structure
  45 that defines what capabilities it is exporting through this interface. The
  46 value returned by this call is guaranteed to be valid until it is passed into a
  47 call to \fBnet_protocol_release\fR(9F), after which it should no longer be
  48 treated as valid.
  49 .sp
  50 .LP
  51 The protocol must be a registered name of a network protocol that has been
  52 registered. The symbols \fBNHF_INET\fR and \fBNHF_INET6\fR should be passed to
  53 \fBnet_protocol_lookup()\fR as the protocol name to gain access to either
  54 \fBIPv4\fR or \fBIPv6\fR respectively.
  55 .SH RETURN VALUES
  56 .sp
  57 .LP
  58 The \fBnet_protocol_lookup()\fR function returns \fBNULL\fR if it does not find
  59 any knowledge about the network protocol referenced. Otherwise, it returns a
  60 value that can be used with other calls in this framework.
  61 .SH CONTEXT
  62 .sp
  63 .LP
  64 The \fBnet_protocol_lookup()\fR function may be called from user,  kernel, or
  65 interrupt context.
  66 .SH ATTRIBUTES
  67 .sp
  68 .LP
  69 See \fBattributes\fR(5) for descriptions of the following attributes:
  70 .sp
  71
  72 .sp
  73 .TS
  74 box;
  75 c | c
  76 l | l .
  77 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  78 _
  79 Interface Stability     Committed
  80 .TE
  81
  82 .SH SEE ALSO
  83 .sp
  84 .LP
  85 \fBnet_protocol_release\fR(9F), \fBattributes\fR(5)