man3/byteorder.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sat Jul 24 21:29:05 1993 by Rik Faith (faith@cs.unc.edu)
  30 .\" Modified Thu Jul 26 14:06:20 2001 by Andries Brouwer (aeb@cwi.nl)
  31 .\"
  32 .TH BYTEORDER 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  33 .SH NAME
  34 htonl, htons, ntohl, ntohs \- convert values between host and network
  35 byte order
  36 .SH SYNOPSIS
  37 .nf
  38 .B #include <arpa/inet.h>
  39 .PP
  40 .BI "uint32_t htonl(uint32_t " hostlong );
  41 .BI "uint16_t htons(uint16_t " hostshort );
  42 .PP
  43 .BI "uint32_t ntohl(uint32_t " netlong );
  44 .BI "uint16_t ntohs(uint16_t " netshort );
  45 .fi
  46 .SH DESCRIPTION
  47 The
  48 .BR htonl ()
  49 function converts the unsigned integer
  50 .I hostlong
  51 from host byte order to network byte order.
  52 .PP
  53 The
  54 .BR htons ()
  55 function converts the unsigned short integer
  56 .I hostshort
  57 from host byte order to network byte order.
  58 .PP
  59 The
  60 .BR ntohl ()
  61 function converts the unsigned integer
  62 .I netlong
  63 from network byte order to host byte order.
  64 .PP
  65 The
  66 .BR ntohs ()
  67 function converts the unsigned short integer
  68 .I netshort
  69 from network byte order to host byte order.
  70 .PP
  71 On the i386 the host byte order is Least Significant Byte first,
  72 whereas the network byte order, as used on the Internet, is Most
  73 Significant Byte first.
  74 .SH ATTRIBUTES
  75 For an explanation of the terms used in this section, see
  76 .BR attributes (7).
  77 .ad l
  78 .nh
  79 .TS
  80 allbox;
  81 lbx lb lb
  82 l l l.
  83 Interface       Attribute       Value
  84 T{
  85 .BR htonl (),
  86 .BR htons (),
  87 .BR ntohl (),
  88 .BR ntohs ()
  89 T}      Thread safety   MT-Safe
  90 .TE
  91 .hy
  92 .ad
  93 .sp 1
  94 .SH CONFORMING TO
  95 POSIX.1-2001, POSIX.1-2008.
  96 .PP
  97 Some systems require the inclusion of
  98 .I <netinet/in.h>
  99 instead of
 100 .IR <arpa/inet.h> .
 101 .SH SEE ALSO
 102 .BR bswap (3),
 103 .BR endian (3),
 104 .BR gethostbyname (3),
 105 .BR getservent (3)