draft/man3/getnameinfo.3

   1 .\" This page is in the public domain.
   2 .\" Almost all details are from RFC 2553.
   3 .\"
   4 .\" 2004-12-14, mtk, Added EAI_OVERFLOW error
   5 .\" 2004-12-14 Fixed description of error return
   6 .\"
   7 .\"*******************************************************************
   8 .\"
   9 .\" This file was generated with po4a. Translate the source file.
  10 .\"
  11 .\"*******************************************************************
  12 .TH GETNAMEINFO 3 2009\-12\-03 GNU "Linux Programmer's Manual"
  13 .SH 名前
  14 getnameinfo \- アドレスから名前への変換をプロトコルに依存しないかたちで行う
  15 .SH 書式
  16 .nf
  17 \fB#include <sys/socket.h>\fP
  18 \fB#include <netdb.h>\fP
  19 .sp
  20 \fBint getnameinfo(const struct sockaddr *\fP\fIsa\fP\fB, socklen_t \fP\fIsalen\fP\fB,\fP
  21 \fB                char *\fP\fIhost\fP\fB, size_t \fP\fIhostlen\fP\fB,\fP
  22 \fB                char *\fP\fIserv\fP\fB, size_t \fP\fIservlen\fP\fB, int \fP\fIflags\fP\fB);\fP
  23 .fi
  24 .sp
  25 .in -4n
  26 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  27 .ad l
  28 .in
  29 .sp
  30 \fBgetnameinfo\fP(): _POSIX_C_SOURCE\ >=\ 1 || _XOPEN_SOURCE ||
  31 _POSIX_SOURCE
  32 .ad b
  33 .SH 説明
  34 \fBgetnameinfo\fP()  関数は、 \fBgetaddrinfo\fP(3)  の逆の動作を行う。つまり、プロトコルに依存しないかたちで
  35 ソケットアドレスから対応するホスト名とサービスへの変換を行う。 この関数は \fBgethostbyaddr\fP(3)  と
  36 \fBgetservbyport\fP(3)  の機能を一つにしたものだが、 これらの関数と違い、 \fBgetnameinfo\fP(3)
  37 はリエントラントであり、IPv4 と IPv6 の差分に依存しないかたちで プログラムを書くことができる。
  38
  39 \fIsa\fP 引き数は、 IP アドレスとポート番号の情報を保持している 汎用的なソケットアドレス構造体 (\fIsockaddr_in\fP 型または
  40 \fIsockaddr_in6\fP 型) へのポインタである。 \fIsalen\fP は \fIsa\fP のサイズである。 \fIhost\fP と \fIserv\fP
  41 引き数は、(それぞれサイズが \fIhostlen\fP と \fIservlen\fP の) 呼び出し側で確保されたバッファへのポインタであり、
  42 ホスト名とサービス名を含む NULL 終端された文字列が それぞれのバッファに格納される。
  43
  44 ホスト名が不要であることをこの関数に伝えるには、 \fIhost\fP に NULL を指定するか、 \fIhostlen\fP に 0
  45 を指定する。同様に、サービス名が不要な場合は、 \fIserv\fP に NULL を指定するか、 \fIservlen\fP に 0 を指定する。
  46 しかし、ホスト名とサービス名の両方を不要だと指定することはできない (いずれか一方は要求すること)。
  47
  48 \fIflags\fP 引き数で \fBgetnameinfo\fP()  の動作を変えることができる。指定できる値は以下の通り:
  49 .TP
  50 \fBNI_NAMEREQD\fP
  51 指定すると、ホスト名が決定できなかった場合にエラーを返す。
  52 .TP
  53 \fBNI_DGRAM\fP
  54 指定すると、ストリームベース (TCP) でなくデータグラムベース (UDP)  のサービスを対象にする。数は少ないが、 UDP と TCP
  55 で違うサービスを提供しているポート (512\-514) に対して必要となる。
  56 .TP
  57 \fBNI_NOFQDN\fP
  58 指定すると、ローカルなホストには fully qualified domain name (FQDN) の ホスト名の部分のみを返す。
  59 .TP
  60 \fBNI_NUMERICHOST\fP
  61 .\" For example, by calling
  62 .\" .BR inet_ntop ()
  63 .\" instead of
  64 .\" .BR gethostbyaddr ().
  65 .\" POSIX.1-2003 has NI_NUMERICSCOPE, but glibc doesn't have it.
  66 指定すると、数値形式のホスト名が返される。 (指定しなくても、ノードの名前が決定できない場合は数値形式が返ることがある)。
  67 .TP
  68 \fBNI_NUMERICSERV\fP
  69 指定すると、数値形式のサービス名 (例えばポート番号) が返される (指定しなくても、サービス名が決定できない場合は数値形式が返ることがある)。
  70 .SS "国際化ドメイン名のための getaddrinfo() の拡張"
  71 .PP
  72 glibc 2.3.4 から、 \fBgetnameinfo\fP()  に拡張が行われ、ホスト名と 国際化ドメイン名 (Internationalized
  73 Domain Name; IDN) 形式との間で 透過的な変換ができるようになっている (IDN 形式については RFC 3490 の
  74 \fIInternationalizing Domain Names in Applications (IDNA)\fP
  75 を参照)。3つのフラグが新たに定義されている:
  76 .TP
  77 \fBNI_IDN\fP
  78 このフラグを指定すると、必要であれば、検索処理で見つかった名前は IDN 形式からロケールに応じた符号化形式に変換される。 ASCII
  79 文字だけの名前はこの変換では影響を受けない。このため、 既存のプログラムや環境でこのフラグを使うことができる。
  80 .TP
  81 \fBNI_IDN_ALLOW_UNASSIGNED\fP, \fBNI_IDN_USE_STD3_ASCII_RULES\fP
  82 これらのフラグをセットすると、IDNA 処理で使用されるフラグ IDNA_ALLOW_UNASSIGNED (未割り当ての Unicode
  83 のコードポイントを許容) と IDNA_USE_STD3_ASCII_RULES (出力が STD3 準拠のホスト名かをチェックする)
  84 がそれぞれ有効になる。
  85 .SH 返り値
  86 .\" FIXME glibc defines the following additional errors, some which
  87 .\" can probably be returned by getnameinfo(); they need to
  88 .\" be documented.
  89 .\" #ifdef __USE_GNU
  90 .\" #define EAI_INPROGRESS  -100  /* Processing request in progress.  */
  91 .\" #define EAI_CANCELED    -101  /* Request canceled.  */
  92 .\" #define EAI_NOTCANCELED -102  /* Request not canceled.  */
  93 .\" #define EAI_ALLDONE     -103  /* All requests done.  */
  94 .\" #define EAI_INTR        -104  /* Interrupted by a signal.  */
  95 .\" #define EAI_IDN_ENCODE  -105  /* IDN encoding failed.  */
  96 .\" #endif
  97 成功すると 0 が返り、(要求されていれば) ノードとサービスの名前が NULL 終端された文字列の形式でそれぞれの指定バッファに返される
  98 (バッファの長さにあうように縮められるかもしれない)。 エラーの場合は、以下の 0 以外のエラー・コードが返される:
  99 .TP
 100 \fBEAI_AGAIN\fP
 101 指定された名前が現時点では解決できなかった。 後で再試行してみること。
 102 .TP
 103 \fBEAI_BADFLAGS\fP
 104 \fIflags\fP 引き数に不正な値が与えられた。
 105 .TP
 106 \fBEAI_FAIL\fP
 107 回復できないエラーが発生した。
 108 .TP
 109 \fBEAI_FAMILY\fP
 110 指定したアドレスファミリーが認識できなかった。 あるいはアドレスの長さが指定されたファミリーに合うものでなかった。
 111 .TP
 112 \fBEAI_MEMORY\fP
 113 メモリが足りない。
 114 .TP
 115 \fBEAI_NONAME\fP
 116 与えられたパラメータでは名前が解決できない。 \fBNI_NAMEREQD\fP が設定されていたがホスト名が決定できなかったか、
 117 ホスト名もサービス名も要求されなかった。
 118 .TP
 119 \fBEAI_OVERFLOW\fP
 120 \fIhost\fP または \fIserv\fP が指しているバッファが小さすぎた。
 121 .TP
 122 \fBEAI_SYSTEM\fP
 123 システムエラーが起った。 エラーコードは \fIerrno\fP に設定される。
 124 .PP
 125 \fBgai_strerror\fP(3) 関数を使うと、これらのエラー・コードを、エラー・レポートに適した 人間が読みやすい文字列に翻訳してくれる。
 126 .SH ファイル
 127 /etc/hosts
 128 .br
 129 /etc/nsswitch.conf
 130 .br
 131 /etc/resolv.conf
 132 .SH バージョン
 133 \fBgetnameinfo\fP()  は、glibc バージョン 2.1 以降で提供されている。
 134 .SH 準拠
 135 RFC\ 2553, POSIX.1\-2001.
 136 .SH 注意
 137 適切なバッファサイズを選択できるように、 \fI<netdb.h>\fP に以下の定数が定義されている。
 138 .in +4n
 139 .nf
 140
 141 #define NI_MAXHOST      1025
 142 #define NI_MAXSERV      32
 143 .fi
 144 .in
 145
 146 glibc 2.8 以降では、機能検査マクロ \fB_BSD_SOURCE\fP, \fB_SVID_SOURCE\fP, \fB_GNU_SOURCE\fP
 147 のいずれかが定義された場合にのみ、これらの定義が公開される。
 148 .PP
 149 前者は、最近のバージョンの BIND のヘッダファイル \fI<arpa/nameser.h>\fP 中の定数 \fBMAXDNAME\fP
 150 と同じ値である。 後者は、割り当て済の数値について記した現在の RFC に 列挙されてサービスから推量した値である。
 151 .SH 例
 152 以下のコードは、指定されたソケットアドレスに対する ホストとサービスの数値表式を取得しようと試みる。 特定のアドレスファミリーに対する参照情報は
 153 一切ハードコードされていないことに着目してほしい。
 154
 155 .in +4n
 156 .nf
 157 struct sockaddr *sa;    /* input */
 158 socklen_t len;          /* input */
 159 char hbuf[NI_MAXHOST], sbuf[NI_MAXSERV];
 160
 161 if (getnameinfo(sa, len, hbuf, sizeof(hbuf), sbuf,
 162             sizeof(sbuf), NI_NUMERICHOST | NI_NUMERICSERV) == 0)
 163     printf("host=%s, serv=%s\en", hbuf, sbuf);
 164 .fi
 165 .in
 166
 167 以下ではソケットアドレスに 逆向きのアドレスマッピングが存在するかをチェックしている。
 168
 169 .in +4n
 170 .nf
 171 struct sockaddr *sa;    /* input */
 172 socklen_t len;          /* input */
 173 char hbuf[NI_MAXHOST];
 174
 175 if (getnameinfo(sa, len, hbuf, sizeof(hbuf),
 176             NULL, 0, NI_NAMEREQD))
 177     printf("could not resolve hostname");
 178 else
 179     printf("host=%s\en", hbuf);
 180 .fi
 181 .in
 182 .PP
 183 \fBgetnameinfo\fP()  を使ったプログラム例が \fBgetaddrinfo\fP(3)  に記載されている。
 184 .SH 関連項目
 185 \fBaccept\fP(2), \fBgetpeername\fP(2), \fBgetsockname\fP(2), \fBrecvfrom\fP(2),
 186 \fBsocket\fP(2), \fBgetaddrinfo\fP(3), \fBgethostbyaddr\fP(3), \fBgetservbyname\fP(3),
 187 \fBgetservbyport\fP(3), \fBinet_ntop\fP(3), \fBhosts\fP(5), \fBservices\fP(5),
 188 \fBhostname\fP(7), \fBnamed\fP(8)
 189 .LP
 190 R. Gilligan, S. Thomson, J. Bound and W. Stevens, \fIBasic Socket Interface
 191 Extensions for IPv6\fP, RFC\ 2553, March 1999.
 192 .LP
 193 Tatsuya Jinmei and Atsushi Onoe, \fIAn Extension of Format for IPv6 Scoped
 194 Addresses\fP, internet draft, work in progress.
 195 ftp://ftp.ietf.org/internet\-drafts/draft\-ietf\-ipngwg\-scopedaddr\-format\-02.txt
 196 .LP
 197 Craig Metz, \fIProtocol Independence Using the Sockets API\fP, Proceedings of
 198 the freenix track: 2000 USENIX annual technical conference, June 2000.
 199 http://www.usenix.org/publications/library/proceedings/usenix2000/freenix/metzprotocol.html