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