usr/src/man/man9f/net_getlifaddr.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_GETLIFADDR 9F "Oct 13, 2008"
   7 .SH NAME
   8 net_getlifaddr \- determine a network address for a given interface
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/neti.h>
  13
  14 \fBint\fR \fBnet_getlifaddr\fR(\fBconst\fR \fBnet_data_t\fR \fInet\fR, \fBconst\fR \fBphy_if_t\fR \fIifp\fR,
  15      \fBconst\fR \fBnet_if_t\fR \fIlif\fR, \fBint\fR \fBconst\fR \fItype\fR,
  16      \fBstruct\fR \fBsockaddr*\fR \fIstorage\fR);
  17 .fi
  18
  19 .SH INTERFACE LEVEL
  20 .sp
  21 .LP
  22 Solaris DDI specific (Solaris DDI).
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fInet\fR\fR
  28 .ad
  29 .RS 11n
  30 value returned from a successful call to \fBnet_protocol_lookup\fR(9F).
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIifp\fR\fR
  37 .ad
  38 .RS 11n
  39 value returned from a successful call to \fBnet_phylookup\fR(9F) or
  40 \fBnet_phygetnext\fR(9F), indicating which network interface the information
  41 should be returned from.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fIlif\fR\fR
  48 .ad
  49 .RS 11n
  50 indicates the logical interface from which to fetch the address.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fItype\fR\fR
  57 .ad
  58 .RS 11n
  59 indicates what type of address should be returned. See below for more details
  60 on this field.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fIstorage\fR\fR
  67 .ad
  68 .RS 11n
  69 pointer to an area of memory to store the address data.
  70 .RE
  71
  72 .SH DESCRIPTION
  73 .sp
  74 .LP
  75 The \fBnet_getlifaddr()\fR function retrieves the address information for each
  76 logical interface. Each call to \fBnet_getlifaddr()\fR requires that the caller
  77 pass a pointer to an array of address information types to retrieve, and an
  78 accompanying pointer to an array of pointers to \fBstruct sockaddr\fR
  79 structures to which to copy the address information. See
  80 \fBnet_lifgetnext\fR(9F) for an example on how to use this function.
  81 .sp
  82 .LP
  83 Each member of the address \fBtype\fR array should be one of the values listed
  84 here.
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBNA_ADDRESS\fR\fR
  89 .ad
  90 .RS 16n
  91 Return the network address associated with the logical interface (\fBlif\fR)
  92 that belongs to the network interface (\fBifp\fR).
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBNA_PEER\fR\fR
  99 .ad
 100 .RS 16n
 101 Return the address assigned to the remote host for point to point network
 102 interfaces for the given network/logical interface.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBNA_BROADCAST\fR\fR
 109 .ad
 110 .RS 16n
 111 Return the broadcast address assigned to the given network/logical interface
 112 for network interfaces that support broadcast packets.
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBNA_NETMASK\fR\fR
 119 .ad
 120 .RS 16n
 121 Return the netmask associated with the given network/logical interface for
 122 network interfaces that support broadcast packets.
 123 .RE
 124
 125 .SH RETURN VALUES
 126 .sp
 127 .LP
 128 The \fBnet_getlifaddr()\fR function returns:
 129 .sp
 130 .ne 2
 131 .na
 132 \fB-1\fR
 133 .ad
 134 .RS 6n
 135 The network protocol does not support this function.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB0\fR
 142 .ad
 143 .RS 6n
 144 Successful completion.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB1\fR
 151 .ad
 152 .RS 6n
 153 Unsuccessful.
 154 .RE
 155
 156 .SH CONTEXT
 157 .sp
 158 .LP
 159 The \fBnet_getifaddr()\fR function may be called from user, kernel, or
 160 interrupt context.
 161 .SH ATTRIBUTES
 162 .sp
 163 .LP
 164 See \fBattributes\fR(5) for descriptions of the following attributes:
 165 .sp
 166
 167 .sp
 168 .TS
 169 box;
 170 c | c
 171 l | l .
 172 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 173 _
 174 Interface Stability     Committed
 175 .TE
 176
 177 .SH SEE ALSO
 178 .sp
 179 .LP
 180 \fBnet_lifgetnext\fR(9F), \fBnet_phylookup\fR(9F),
 181 \fBnet_phygetnext\fR(9F), \fBnet_protocol_lookup\fR(9F)