external/bsd/bind/dist/lib/lwres/man/lwres_getnameinfo.3

   1 .\"     $NetBSD: lwres_getnameinfo.3,v 1.5 2014/12/10 04:38:02 christos Exp $
   2 .\"
   3 .\" Copyright (C) 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
   4 .\" Copyright (C) 2000, 2001 Internet Software Consortium.
   5 .\"
   6 .\" Permission to use, copy, modify, and/or distribute this software for any
   7 .\" purpose with or without fee is hereby granted, provided that the above
   8 .\" copyright notice and this permission notice appear in all copies.
   9 .\"
  10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  11 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  12 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  13 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  14 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  15 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  16 .\" PERFORMANCE OF THIS SOFTWARE.
  17 .\"
  18 .\" Id
  19 .\"
  20 .hy 0
  21 .ad l
  22 .\"     Title: lwres_getnameinfo
  23 .\"    Author:
  24 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  25 .\"      Date: June 18, 2007
  26 .\"    Manual: BIND9
  27 .\"    Source: BIND9
  28 .\"
  29 .TH "LWRES_GETNAMEINFO" "3" "June 18, 2007" "BIND9" "BIND9"
  30 .\" disable hyphenation
  31 .nh
  32 .\" disable justification (adjust text to left margin only)
  33 .ad l
  34 .SH "NAME"
  35 lwres_getnameinfo \- lightweight resolver socket address structure to hostname and service name
  36 .SH "SYNOPSIS"
  37 .nf
  38 #include <lwres/netdb.h>
  39 .fi
  40 .HP 22
  41 .BI "int lwres_getnameinfo(const\ struct\ sockaddr\ *" "sa" ", size_t\ " "salen" ", char\ *" "host" ", size_t\ " "hostlen" ", char\ *" "serv" ", size_t\ " "servlen" ", int\ " "flags" ");"
  42 .SH "DESCRIPTION"
  43 .PP
  44 This function is equivalent to the
  45 \fBgetnameinfo\fR(3)
  46 function defined in RFC2133.
  47 \fBlwres_getnameinfo()\fR
  48 returns the hostname for the
  49 \fBstruct sockaddr\fR
  50 \fIsa\fR
  51 which is
  52 \fIsalen\fR
  53 bytes long. The hostname is of length
  54 \fIhostlen\fR
  55 and is returned via
  56 \fI*host.\fR
  57 The maximum length of the hostname is 1025 bytes:
  58 \fBNI_MAXHOST\fR.
  59 .PP
  60 The name of the service associated with the port number in
  61 \fIsa\fR
  62 is returned in
  63 \fI*serv.\fR
  64 It is
  65 \fIservlen\fR
  66 bytes long. The maximum length of the service name is
  67 \fBNI_MAXSERV\fR
  68 \- 32 bytes.
  69 .PP
  70 The
  71 \fIflags\fR
  72 argument sets the following bits:
  73 .PP
  74 \fBNI_NOFQDN\fR
  75 .RS 4
  76 A fully qualified domain name is not required for local hosts. The local part of the fully qualified domain name is returned instead.
  77 .RE
  78 .PP
  79 \fBNI_NUMERICHOST\fR
  80 .RS 4
  81 Return the address in numeric form, as if calling inet_ntop(), instead of a host name.
  82 .RE
  83 .PP
  84 \fBNI_NAMEREQD\fR
  85 .RS 4
  86 A name is required. If the hostname cannot be found in the DNS and this flag is set, a non\-zero error code is returned. If the hostname is not found and the flag is not set, the address is returned in numeric form.
  87 .RE
  88 .PP
  89 \fBNI_NUMERICSERV\fR
  90 .RS 4
  91 The service name is returned as a digit string representing the port number.
  92 .RE
  93 .PP
  94 \fBNI_DGRAM\fR
  95 .RS 4
  96 Specifies that the service being looked up is a datagram service, and causes getservbyport() to be called with a second argument of "udp" instead of its default of "tcp". This is required for the few ports (512\-514) that have different services for UDP and TCP.
  97 .RE
  98 .SH "RETURN VALUES"
  99 .PP
 100 \fBlwres_getnameinfo()\fR
 101 returns 0 on success or a non\-zero error code if an error occurs.
 102 .SH "SEE ALSO"
 103 .PP
 104 \fBRFC2133\fR(),
 105 \fBgetservbyport\fR(3),
 106 \fBlwres\fR(3),
 107 \fBlwres_getnameinfo\fR(3),
 108 \fBlwres_getnamebyaddr\fR(3).
 109 \fBlwres_net_ntop\fR(3).
 110 .SH "BUGS"
 111 .PP
 112 RFC2133 fails to define what the nonzero return values of
 113 \fBgetnameinfo\fR(3)
 114 are.
 115 .SH "COPYRIGHT"
 116 Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
 117 .br
 118 Copyright \(co 2000, 2001 Internet Software Consortium.
 119 .br