xref: /minix3/lib/libc/net/byteorder.3 (revision f14fb602092e015ff630df58e17c2a9cd57d29b3)
1*f14fb602SLionel Sambuc.\"	$NetBSD: byteorder.3,v 1.15 2011/05/03 04:07:39 jruoho Exp $
22fe8fb19SBen Gras.\"
32fe8fb19SBen Gras.\" Copyright (c) 1983, 1991, 1993
42fe8fb19SBen Gras.\"	The Regents of the University of California.  All rights reserved.
52fe8fb19SBen Gras.\"
62fe8fb19SBen Gras.\" Redistribution and use in source and binary forms, with or without
72fe8fb19SBen Gras.\" modification, are permitted provided that the following conditions
82fe8fb19SBen Gras.\" are met:
92fe8fb19SBen Gras.\" 1. Redistributions of source code must retain the above copyright
102fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer.
112fe8fb19SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright
122fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer in the
132fe8fb19SBen Gras.\"    documentation and/or other materials provided with the distribution.
142fe8fb19SBen Gras.\" 3. Neither the name of the University nor the names of its contributors
152fe8fb19SBen Gras.\"    may be used to endorse or promote products derived from this software
162fe8fb19SBen Gras.\"    without specific prior written permission.
172fe8fb19SBen Gras.\"
182fe8fb19SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
192fe8fb19SBen Gras.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
202fe8fb19SBen Gras.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
212fe8fb19SBen Gras.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
222fe8fb19SBen Gras.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
232fe8fb19SBen Gras.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
242fe8fb19SBen Gras.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
252fe8fb19SBen Gras.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
262fe8fb19SBen Gras.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
272fe8fb19SBen Gras.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
282fe8fb19SBen Gras.\" SUCH DAMAGE.
292fe8fb19SBen Gras.\"
302fe8fb19SBen Gras.\"     @(#)byteorder.3	8.1 (Berkeley) 6/4/93
312fe8fb19SBen Gras.\"
32*f14fb602SLionel Sambuc.Dd May 3, 2011
332fe8fb19SBen Gras.Dt BYTEORDER 3
342fe8fb19SBen Gras.Os
352fe8fb19SBen Gras.Sh NAME
362fe8fb19SBen Gras.Nm htonl ,
372fe8fb19SBen Gras.Nm htons ,
382fe8fb19SBen Gras.Nm ntohl ,
392fe8fb19SBen Gras.Nm ntohs
402fe8fb19SBen Gras.Nd convert values between host and network byte order
412fe8fb19SBen Gras.Sh LIBRARY
422fe8fb19SBen Gras.Lb libc
432fe8fb19SBen Gras.Sh SYNOPSIS
442fe8fb19SBen Gras.In arpa/inet.h
452fe8fb19SBen Gras.Ft uint32_t
462fe8fb19SBen Gras.Fn htonl "uint32_t host32"
472fe8fb19SBen Gras.Ft uint16_t
482fe8fb19SBen Gras.Fn htons "uint16_t host16"
492fe8fb19SBen Gras.Ft uint32_t
502fe8fb19SBen Gras.Fn ntohl "uint32_t net32"
512fe8fb19SBen Gras.Ft uint16_t
522fe8fb19SBen Gras.Fn ntohs "uint16_t net16"
532fe8fb19SBen Gras.Sh DESCRIPTION
542fe8fb19SBen GrasThese routines convert 16 and 32 bit quantities between network
552fe8fb19SBen Grasbyte order and host byte order.
562fe8fb19SBen Gras.Pp
572fe8fb19SBen GrasOn machines which have a byte order which is the same as the network
582fe8fb19SBen Grasorder, these routines are defined as macros that expand to the value of
592fe8fb19SBen Grastheir argument.
602fe8fb19SBen Gras.Pp
612fe8fb19SBen GrasThese routines are most often used in conjunction with Internet
622fe8fb19SBen Grasaddresses and ports as returned by
632fe8fb19SBen Gras.Xr gethostbyname 3
642fe8fb19SBen Grasand
652fe8fb19SBen Gras.Xr getservent 3 .
662fe8fb19SBen Gras.Sh SEE ALSO
67*f14fb602SLionel Sambuc.Xr bswap 3 ,
682fe8fb19SBen Gras.Xr gethostbyname 3 ,
692fe8fb19SBen Gras.Xr getservent 3
702fe8fb19SBen Gras.Sh STANDARDS
71*f14fb602SLionel SambucThe described functions conform to
722fe8fb19SBen Gras.St -p1003.1-2001 .
732fe8fb19SBen Gras.Sh HISTORY
742fe8fb19SBen GrasThe
752fe8fb19SBen Gras.Nm byteorder
762fe8fb19SBen Grasfunctions appeared in
772fe8fb19SBen Gras.Bx 4.2 .
782fe8fb19SBen Gras.Sh BUGS
792fe8fb19SBen GrasThe `l' and `s' suffixes in the names are not meaningful in machines
802fe8fb19SBen Graswhere long integers are not 32 bits.
81