share/man/man3head/in.h.3head

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
  45 .\"
  46 .TH IN.H 3HEAD "Aug 30, 2002"
  47 .SH NAME
  48 in.h, in \- Internet Protocol family
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <netinet/in.h>
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .LP
  57 The <\fBnetinet/in.h\fR> header defines the following types through
  58 \fBtypedef\fR:
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBin_port_t\fR\fR
  63 .ad
  64 .RS 13n
  65 An unsigned integral type of exactly 16 bits.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBin_addr_t\fR\fR
  72 .ad
  73 .RS 13n
  74 An unsigned integral type of exactly 32 bits. The <\fBnetinet/in.h\fR> header
  75 defines the \fBin_addr\fR structure that includes the following member:
  76 .RE
  77
  78 .sp
  79 .LP
  80 The <\fBnetinet/in.h\fR> header defines the \fBin_addr\fR structure that
  81 includes the following member:
  82 .sp
  83 .in +2
  84 .nf
  85 in_addr_t       s_addr
  86 .fi
  87 .in -2
  88
  89 .sp
  90 .LP
  91 The <\fBnetinet/in.h\fR> header defines the type \fBsa_family_t\fR as described
  92 in \fBsocket.h\fR(3HEAD).
  93 .sp
  94 .LP
  95 The <\fBnetinet/in.h\fR> header defines the following macros for use as values
  96 of the \fIlevel\fR argument of \fBgetsockopt()\fR and \fBsetsockopt()\fR:
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBIPPROTO_IP\fR \fR
 101 .ad
 102 .RS 21n
 103 Dummy for  \fBIP\fR
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBIPPROTO_ICMP\fR \fR
 110 .ad
 111 .RS 21n
 112 Control message protocol
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBIPPROTO_TCP\fR \fR
 119 .ad
 120 .RS 21n
 121 \fBTCP\fR
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBIPPROTO_UDP\fR \fR
 128 .ad
 129 .RS 21n
 130 User datagram protocol The <\fBnetinet/in.h\fR> header defines the following
 131 macros for use as destination addresses for \fBconnect()\fR, \fBsendmsg()\fR,
 132 and \fBsendto()\fR:
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fBINADDR_ANY\fR \fR
 139 .ad
 140 .RS 21n
 141 Local host address
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fBINADDR_BROADCAST\fR \fR
 148 .ad
 149 .RS 21n
 150 Broadcast address
 151 .RE
 152
 153 .sp
 154 .LP
 155 The <\fBnetinet/in.h\fR> header defines the \fBsockaddr_in\fR structure that is
 156 used to store addresses for the Internet protocol family.  Values of this type
 157 must be cast to \fBstruct sockaddr\fR for use with the socket interfaces.
 158 .SS "Default"
 159 .LP
 160 For applications that do not require standard-conforming behavior (those that
 161 use the socket interfaces described in section (3SOCKET) of the reference
 162 manual; see \fBIntro\fR(3) and \fBstandards\fR(5)), the <\fBnetinet/in.h\fR>
 163 header defines the \fBsockaddr_in\fR structure that includes the following
 164 members:
 165 .sp
 166 .in +2
 167 .nf
 168 sa_family_t     sin_family
 169 in_port_t       sin_port
 170 struct in_addr  sin_addr
 171 char            sin_zero[8]
 172 .fi
 173 .in -2
 174
 175 .SS "Standard conforming"
 176 .LP
 177 For applications that require standard-conforming behavior (those that use the
 178 socket interfaces described in section (3XNET) of the reference manual; see
 179 \fBIntro\fR(3) and \fBstandards\fR(5)), the <\fBnetinet/in.h\fR> header defines
 180 the \fBsockaddr_in\fR structure that includes the following members:
 181 .sp
 182 .in +2
 183 .nf
 184 sa_family_t     sin_family
 185 in_port_t       sin_port
 186 struct in_addr  sin_addr
 187 unsigned char   sin_zero[8]
 188 .fi
 189 .in -2
 190
 191 .SH ATTRIBUTES
 192 .LP
 193 See \fBattributes\fR(5) for descriptions of the following attributes:
 194 .sp
 195
 196 .sp
 197 .TS
 198 box;
 199 c | c
 200 l | l .
 201 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 202 _
 203 Interface Stability     Standard
 204 .TE
 205
 206 .SH SEE ALSO
 207 .LP
 208 \fBIntro\fR(3), \fBconnect\fR(3SOCKET), \fBconnect\fR(3XNET),
 209 \fBgetsockopt\fR(3SOCKET), \fBgetsockopt\fR(3XNET), \fBsendmsg\fR(3SOCKET),
 210 \fBsendmsg\fR(3XNET), \fBsendto\fR(3SOCKET), \fBsendto\fR(3XNET),
 211 \fBsetsockopt\fR(3SOCKET), \fBsetsockopt\fR(3XNET), \fBsockaddr\fR(3SOCKET),
 212 \fBsocket.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)