xref: /dragonfly/lib/libc/net/byteorder.3 (revision 2038fb68)
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.\" 4. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)byteorder.3	8.1 (Berkeley) 6/4/93
29.\" $FreeBSD: src/lib/libc/net/byteorder.3,v 1.13 2007/01/09 00:28:01 imp Exp $
30.\" $DragonFly: src/lib/libc/net/byteorder.3,v 1.3 2004/09/15 15:04:31 joerg Exp $
31.\"
32.Dd March 20, 2005
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.Pp
46or
47.Pp
48.In netinet/in.h
49.Ft uint32_t
50.Fn htonl "uint32_t hostlong"
51.Ft uint16_t
52.Fn htons "uint16_t hostshort"
53.Ft uint32_t
54.Fn ntohl "uint32_t netlong"
55.Ft uint16_t
56.Fn ntohs "uint16_t netshort"
57.Sh DESCRIPTION
58These routines convert 16 and 32 bit quantities between network
59byte order and host byte order.
60On machines which have a byte order which is the same as the network
61order, routines are defined as null macros.
62.Pp
63These routines are most often used in conjunction with Internet
64addresses and ports as returned by
65.Xr gethostbyname 3
66and
67.Xr getservent 3 .
68.Sh SEE ALSO
69.Xr gethostbyname 3 ,
70.Xr getservent 3 ,
71.Xr byteorder 9
72.Sh STANDARDS
73The
74.Nm byteorder
75functions conform to
76.St -p1003.1-2001 .
77.Sh HISTORY
78The
79.Nm byteorder
80functions appeared in
81.Bx 4.2 .
82.Sh BUGS
83On the
84.Tn VAX
85bytes are handled backwards from most everyone else in
86the world.
87This is not expected to be fixed in the near future.
88