xref: /netbsd-src/lib/libc/net/byteorder.3 (revision 4b896b232495b7a9b8b94a1cf1e21873296d53b8)
1.\"	$NetBSD: byteorder.3,v 1.11 2003/08/07 16:43:07 agc 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 4, 1993
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 sys/types.h
45.Ft in_addr_t
46.Fn htonl "in_addr_t host32"
47.Ft in_port_t
48.Fn htons "in_port_t host16"
49.Ft in_addr_t
50.Fn ntohl "in_addr_t net32"
51.Ft in_port_t
52.Fn ntohs "in_port_t net16"
53.Sh DESCRIPTION
54These routines convert 16 and 32 bit quantities between network
55byte order and host byte order. The types
56.Ft in_addr_t
57and
58.Ft in_port_t
59are defined by X/Open as:
60.Bd -literal -offset indent
61typedef u_int32_t in_addr_t;
62typedef u_int16_t in_port_t;
63.Ed
64.Pp
65On machines which have a byte order which is the same as the network
66order, routines are defined as null macros.
67.Pp
68These routines are most often used in conjunction with Internet
69addresses and ports as returned by
70.Xr gethostbyname 3
71and
72.Xr getservent 3 .
73.Sh SEE ALSO
74.Xr gethostbyname 3 ,
75.Xr getservent 3
76.Sh HISTORY
77The
78.Nm byteorder
79functions appeared in
80.Bx 4.2 .
81.Sh BUGS
82The `l' and `s' suffixes in the names are not meaningful in machines
83where long integers are not 32 bits.
84