usr/src/man/man9s/hook_nic_event.9s

   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 HOOK_NIC_EVENT 9S "May 1, 2008"
   7 .SH NAME
   8 hook_nic_event \- data structure describing events related to network
   9 interfaces
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/neti.h>
  14 #include <sys/hook.h>
  15 #include <sys/hook_event.h>
  16 .fi
  17
  18 .SH INTERFACE LEVEL
  19 .sp
  20 .LP
  21 Solaris DDI specific (Solaris DDI).
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBhook_nic_event\fR structure contains fields that relate to an event that
  26 has occurred and belongs to a network interface. This structure is passed
  27 through to callbacks for \fBNE_PLUMB\fR, \fBNE_UNPLUMB\fR, \fBNE_UP\fR,
  28 \fBNE_DOWN\fR and \fBNE_ADDRESS_CHANGE\fR events.
  29 .sp
  30 .LP
  31 A callback may not alter any of the fields in this structure.
  32 .SH STRUCTURE MEMBERS
  33 .sp
  34 .in +2
  35 .nf
  36 net_data_t           hne_family;
  37 phy_if_t             pkt_private;
  38 lif_if_t             hne_lif;
  39 nic_event_t          hne_event;
  40 nic_event_data_t     hne_data;
  41 size_t               hne_datalen;
  42
  43 .fi
  44 .in -2
  45
  46 .sp
  47 .LP
  48 The following fields are set for each event:
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBhne_family\fR\fR
  53 .ad
  54 .RS 14n
  55 A valid reference for the network protocol that owns this network interface and
  56 can be in calls to other \fBnetinfo\fR(9F) functions.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBhne_nic\fR\fR
  63 .ad
  64 .RS 14n
  65 The physical interface to which an event belongs.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBhne_event\fR\fR
  72 .ad
  73 .RS 14n
  74 A value that indicates the respective event. The current list of available
  75 events is:
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBNE_PLUMB\fR\fR
  80 .ad
  81 .RS 21n
  82 an interface has just been created.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBNE_UNPLUMB\fR\fR
  89 .ad
  90 .RS 21n
  91 an interface has just been destroyed and no more events should be received for
  92 it.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBNE_UP\fR\fR
  99 .ad
 100 .RS 21n
 101 an interface has changed the state to "up" and may now generate packet events.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBNE_DOWN\fR\fR
 108 .ad
 109 .RS 21n
 110 an interface has changed the state to "down" and will no longer generate packet
 111 events.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBNE_ADDRESS_CHANGE\fR\fR
 118 .ad
 119 .RS 21n
 120 an address on an interface has changed. \fBhne_lif\fR refers to the logical
 121 interface for which the change is occurring, \fBhne_data\fR is a pointer to a
 122 \fBsockaddr\fR structure that is \fBhne_datalen\fR bytes long and contains the
 123 new network address.
 124 .RE
 125
 126 .RE
 127
 128 .SH ATTRIBUTES
 129 .sp
 130 .LP
 131 See \fBattributes\fR(5) for descriptions of the following attributes:
 132 .sp
 133
 134 .sp
 135 .TS
 136 box;
 137 c | c
 138 l | l .
 139 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 140 _
 141 Interface Stability     Committed
 142 .TE
 143
 144 .SH SEE ALSO
 145 .sp
 146 .LP
 147 \fBnetinfo\fR(9F)