usr/src/man/man3head/inet.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 INET.H 3HEAD "Aug 30, 2002"
  47 .SH NAME
  48 inet.h, inet \- definitions for internet operations
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 \fB#include <arpa/inet.h>\fR
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The <\fBarpa/inet.h\fR> header defines the type \fBin_port_t\fR, the type
  59 \fBin_addr_t\fR, and the \fBin_addr\fR structure, as described in
  60 \fBin.h\fR(3HEAD).
  61 .sp
  62 .LP
  63 Inclusion of the <\fBarpa/inet.h\fR> header may also make visible all symbols
  64 from \fBin.h\fR(3HEAD).
  65 .sp
  66 .LP
  67 The following are declared as functions, and may also be defined as macros:
  68 .sp
  69 .in +2
  70 .nf
  71 in_addr_t       inet_addr(const char *);
  72 in_addr_t       inet_lnaof(struct in_addr);
  73 struct in_addr  inet_makeaddr(in_addr_t, in_addr_t);
  74 in_addr_t       inet_netof(struct in_addr);
  75 in_addr_t       inet_network(const char *);
  76 char            *inet_ntoa(struct in_addr);
  77 .fi
  78 .in -2
  79
  80 .SS "Default"
  81 .sp
  82 .LP
  83 For applications that do not require standard-conforming behavior (those that
  84 use the socket interfaces described in section 3N of the reference manual; see
  85 \fBIntro\fR(3) and \fBstandards\fR(5)), the following may be declared as
  86 functions, or defined as macros, or both:
  87 .sp
  88 .in +2
  89 .nf
  90 uint32_t    htonl(uint32_t);
  91 uint16_t    htons(uint16_t);
  92 uint32_t    ntohl(uint32_t);
  93 uint16_t    ntohs(uint16_t);
  94 .fi
  95 .in -2
  96
  97 .SS "Standard conforming"
  98 .sp
  99 .LP
 100 For applications that require standard-conforming behavior (those that use the
 101 socket interfaces described in section 3XN of the reference manual; see
 102 \fBIntro\fR(3) and \fBstandards\fR(5)), the following may be declared as
 103 functions, or defined as macros, or both:
 104 .sp
 105 .in +2
 106 .nf
 107 in_addr_t    htonl(in_addr_t);
 108 in_port_t    htons(in_port_t);
 109 in_addr_t    ntohl(in_addr_t);
 110 in_port_t    ntohs(in_port_t);
 111 .fi
 112 .in -2
 113
 114 .SH ATTRIBUTES
 115 .sp
 116 .LP
 117 See \fBattributes\fR(5) for descriptions of the following attributes:
 118 .sp
 119
 120 .sp
 121 .TS
 122 box;
 123 c | c
 124 l | l .
 125 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 126 _
 127 Interface Stability     Standard
 128 .TE
 129
 130 .SH SEE ALSO
 131 .sp
 132 .LP
 133 \fBIntro\fR(3), \fBhtonl\fR(3SOCKET), \fBhtonl\fR(3XNET),
 134 \fBinet_addr\fR(3SOCKET), \fBinet_addr\fR(3XNET), \fBin.h\fR(3HEAD),
 135 \fBattributes\fR(5), \fBstandards\fR(5)