lib/libc/net/byteorder.3

   1 .\"     $NetBSD: byteorder.3,v 1.13 2005/09/11 02:23:52 soda Exp $
   2 .\"
   3 .\" Copyright (c) 1983, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)byteorder.3 8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Dd June 10, 2004
  33 .Dt BYTEORDER 3
  34 .Os
  35 .Sh NAME
  36 .Nm htonl ,
  37 .Nm htons ,
  38 .Nm ntohl ,
  39 .Nm ntohs
  40 .Nd convert values between host and network byte order
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In arpa/inet.h
  45 .Ft uint32_t
  46 .Fn htonl "uint32_t host32"
  47 .Ft uint16_t
  48 .Fn htons "uint16_t host16"
  49 .Ft uint32_t
  50 .Fn ntohl "uint32_t net32"
  51 .Ft uint16_t
  52 .Fn ntohs "uint16_t net16"
  53 .Sh DESCRIPTION
  54 These routines convert 16 and 32 bit quantities between network
  55 byte order and host byte order.
  56 .Pp
  57 On machines which have a byte order which is the same as the network
  58 order, these routines are defined as macros that expand to the value of
  59 their argument.
  60 .Pp
  61 These routines are most often used in conjunction with Internet
  62 addresses and ports as returned by
  63 .Xr gethostbyname 3
  64 and
  65 .Xr getservent 3 .
  66 .Sh SEE ALSO
  67 .Xr gethostbyname 3 ,
  68 .Xr getservent 3
  69 .Sh STANDARDS
  70 The
  71 .Fn htonl ,
  72 .Fn htons ,
  73 .Fn ntohl ,
  74 and
  75 .Fn ntohs
  76 functions conform to
  77 .St -p1003.1-2001 .
  78 Their use of the fixed-width integer types
  79 .Fa uint16_t
  80 and
  81 .Fa uint32_t
  82 first appeared in
  83 .St -xns5 .
  84 .Sh HISTORY
  85 The
  86 .Nm byteorder
  87 functions appeared in
  88 .Bx 4.2 .
  89 .Sh BUGS
  90 The `l' and `s' suffixes in the names are not meaningful in machines
  91 where long integers are not 32 bits.