lib/libc/net/iso_addr.3

   1 .\" Copyright (c) 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 .\"     @(#)iso_addr.3  8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt ISO_ADDR 3
  37 .Os
  38 .Sh NAME
  39 .Nm iso_addr ,
  40 .Nm iso_ntoa
  41 .Nd "elementary network address conversion routines for Open System Interconnection
  42 .Sh SYNOPSIS
  43 .Fd #include <sys/types.h>
  44 .Fd #include <netiso/iso.h>
  45 .Ft struct iso_addr *
  46 .Fn iso_addr "char *cp"
  47 .Ft char *
  48 .Fn iso_ntoa "struct iso_addr *isoa"
  49 .Sh DESCRIPTION
  50 The routine
  51 .Fn iso_addr
  52 interprets character strings representing
  53 .Tn OSI
  54 addresses, returning binary information suitable
  55 for use in system calls.
  56 The routine
  57 .Fn iso_ntoa
  58 takes
  59 .Tn OSI
  60 addresses and returns
  61 .Tn ASCII
  62 strings representing NSAPs (network service
  63 access points) in a
  64 notation inverse to that accepted by
  65 .Fn iso_addr .
  66 .Pp
  67 Unfortunately, no universal standard exists for representing
  68 .Tn OSI
  69 network addresses.
  70 .Pp
  71 The format employed by
  72 .Fn iso_addr
  73 is a sequence of hexadecimal
  74 .Dq digits
  75 (optionally separated by periods),
  76 of the form:
  77 .Bd -filled -offset indent
  78 <hex digits>.<hex digits>.<hex digits>
  79 .Ed
  80 .Pp
  81 Each pair of hexadecimal digits represents a byte
  82 with the leading digit indicating the higher-ordered bits.
  83 A period following an even number of bytes has no
  84 effect (but may be used to increase legibility).
  85 A period following an odd number of bytes has the
  86 effect of causing the byte of address being translated
  87 to have its higher order bits filled with zeros.
  88 .Sh RETURN VALUES
  89 .Fn iso_ntoa
  90 always returns a null terminated string.
  91 .Fn iso_addr
  92 always returns a pointer to a struct iso_addr.
  93 (See
  94 .Sx BUGS . )
  95 .Sh SEE ALSO
  96 .Xr iso 4
  97 .Sh HISTORY
  98 The
  99 .Fn iso_addr
 100 and
 101 .Fn iso_ntoa
 102 functions appeared in
 103 .Bx 4.3 Reno .
 104 .Sh BUGS
 105 The returned values
 106 reside in a static memory area.
 107 .Pp
 108 The function
 109 .Fn iso_addr
 110 should diagnose improperly formed input, and there should be an unambiguous
 111 way to recognize this.