share/man/man9f/net_instance_register.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_INSTANCE_REGISTER 9F "May 1, 2008"
   7 .SH NAME
   8 net_instance_register \- register a set of instances to occur with IP instance
   9 events
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/neti.h>
  14
  15 \fBint\fR \fBnet_instance_register\fR(\fBnet_instance_t\fR *\fIinstances\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\fIinstances\fR\fR
  27 .ad
  28 .RS 13n
  29 must be a pointer returned by \fBnet_instance_alloc\fR(9F).
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBnet_instance_register()\fR function attempts to record the set of
  36 functions passed by instances that are to be called when an event related to
  37 \fBIP\fR instance maintenance occurs.
  38 .SH RETURN VALUES
  39 .sp
  40 .LP
  41 If the \fBnet_instance_register()\fR function succeeds, \fBDDI_SUCCESS\fR is
  42 returned. Otherwise, \fBDDI_FAILURE\fR is returned to indicate failure due to
  43 the name in the instance already being present.
  44 .SH CONTEXT
  45 .sp
  46 .LP
  47 The \fBnet_instance_register()\fR function may be called from user or kernel
  48 context.
  49 .SH ATTRIBUTES
  50 .sp
  51 .LP
  52 See \fBattributes\fR(5) for descriptions of the following attributes:
  53 .sp
  54
  55 .sp
  56 .TS
  57 box;
  58 c | c
  59 l | l .
  60 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  61 _
  62 Interface Stability     Committed
  63 .TE
  64
  65 .SH SEE ALSO
  66 .sp
  67 .LP
  68 \fBnet_instance_alloc\fR(9F), \fBnet_instance_unregister\fR(9F),
  69 \fBattributes\fR(5), \fBnet_instance_t\fR(9S)