usr/src/man/man3socket/byteorder.3socket

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Copyright 1989 AT&T
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH BYTEORDER 3SOCKET "Mar 10, 2016"
   8 .SH NAME
   9 byteorder, htonl, htonll, htons, ntohl, ntohll, ntohs \- convert values between
  10 host and network byte order
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lsocket\fR \fB -lnsl \fR [ \fIlibrary\fR... ]
  15 #include <sys/types.h>
  16 #include <netinet/in.h>
  17 #include <inttypes.h>
  18
  19 \fBuint32_t\fR \fBhtonl\fR(\fBuint32_t\fR \fIhostlong\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBuint64_t\fR \fBhtonll\fR(\fBuint64_t\fR \fIhostlonglong\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBuint16_t\fR \fBhtons\fR(\fBuint16_t\fR \fIhostshort\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBuint32_t\fR \fBntohl\fR(\fBuint32_t\fR \fInetlong\fR);
  35 .fi
  36
  37 .LP
  38 .nf
  39 \fBuint64_t\fR \fBntohll\fR(\fBuint64_t\fR \fIhostlonglong\fR);
  40 .fi
  41
  42 .LP
  43 .nf
  44 \fBuint16_t\fR \fBntohs\fR(\fBuint16_t\fR \fInetshort\fR);
  45 .fi
  46
  47 .SH DESCRIPTION
  48 .LP
  49 These functions convert 16-bit, 32-bit, and 64-bit quantities between network
  50 byte order and host byte order. On some architectures these routines are
  51 defined as \fINULL\fR macros in the include file <\fBnetinet/in.h\fR>. On other
  52 architectures, the routines are functional when the host byte order is
  53 different from network byte order.
  54 .sp
  55 .LP
  56 These functions are most often used in conjunction with Internet addresses and
  57 ports as returned by \fBgethostent()\fR and \fBgetservent()\fR. See
  58 \fBgethostbyname\fR(3NSL) and \fBgetservbyname\fR(3SOCKET).
  59 .SH ATTRIBUTES
  60 .LP
  61 See \fBattributes\fR(5) for descriptions of the following attributes:
  62 .sp
  63
  64 .sp
  65 .TS
  66 box;
  67 c | c
  68 l | l .
  69 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  70 _
  71 MT-Level        Safe
  72 .TE
  73
  74 .SH SEE ALSO
  75 .LP
  76 \fBgethostbyname\fR(3NSL), \fBgetservbyname\fR(3SOCKET), \fBinet.h\fR(3HEAD),
  77 \fBattributes\fR(5), \fBbyteorder\fR(5)