draft/man3/getservent_r.3

   1 .\" Copyright 2008, Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .\"*******************************************************************
  27 .\"
  28 .\" This file was generated with po4a. Translate the source file.
  29 .\"
  30 .\"*******************************************************************
  31 .TH GETSERVENT_R 3 2010\-09\-10 GNU "Linux Programmer's Manual"
  32 .SH 名前
  33 getservent_r, getservbyname_r, getservbyport_r \- サービスエントリを
  34 取得する (リエントラント版)
  35 .SH 書式
  36 .nf
  37 \fB#include <netdb.h>\fP
  38 .sp
  39 \fBint getservent_r(struct servent *\fP\fIresult_buf\fP\fB, char *\fP\fIbuf\fP\fB,\fP
  40 \fB                size_t \fP\fIbuflen\fP\fB, struct servent **\fP\fIresult\fP\fB);\fP
  41 .sp
  42 \fBint getservbyname_r(const char *\fP\fIname\fP\fB, const char *\fP\fIproto\fP\fB,\fP
  43 \fB                struct servent *\fP\fIresult_buf\fP\fB, char *\fP\fIbuf\fP\fB,\fP
  44 \fB                size_t \fP\fIbuflen\fP\fB, struct servent **\fP\fIresult\fP\fB);\fP
  45 .sp
  46 \fBint getservbyport_r(int \fP\fIport\fP\fB, const char *\fP\fIproto\fP\fB,\fP
  47 \fB                struct servent *\fP\fIresult_buf\fP\fB, char *\fP\fIbuf\fP\fB,\fP
  48 \fB                size_t \fP\fIbuflen\fP\fB, struct servent **\fP\fIresult\fP\fB);\fP
  49 .sp
  50 .fi
  51 .in -4n
  52 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  53 .ad l
  54 .in
  55 .sp
  56 \fBgetservent_r\fP(), \fBgetservbyname_r\fP(), \fBgetservbyport_r\fP():
  57 .RS 4
  58 _BSD_SOURCE || _SVID_SOURCE
  59 .RE
  60 .ad b
  61 .SH 説明
  62 関数 \fBgetservent_r\fP(), \fBgetservbyname_r\fP(), \fBgetservbyport_r\fP() は、
  63 それぞれ \fBgetservent\fP(3), \fBgetservbyname\fP(3), \fBgetservbyport\fP(3) の
  64 リエントラント版である。
  65 \fIservent\fP 構造体の返し方と、関数呼び出し時の引き数と返り値が異なる。
  66 このマニュアルページでは、リエントラントでない関数との違いだけを
  67 説明する。
  68
  69 これらの関数は、関数の結果として静的に割り当てられた \fIservent\fP 構造体
  70 へのポインタを返すのではなく、 \fIservent\fP 構造体を \fIresult_buf\fP が
  71 指す場所にコピーする。
  72
  73 .\" I can find no information on the required/recommended buffer size;
  74 .\" the nonreentrant functions use a 1024 byte buffer -- mtk.
  75 配列 \fIbuf\fP は、返される \fIservent\fP 構造体が指す文字列フィールドを
  76 格納するのに使用される (リエントラントでない関数の場合は、
  77 これらの文字列は静的な領域に格納される)。
  78 この配列の大きさは \fIbuflen\fP で指定される。
  79 \fIbuf\fP が小さすぎる場合、関数呼び出しはエラー \fBERANGE\fP で失敗し、
  80 呼び出し側ではもっと大きなバッファで再度呼び出す必要がある (ほとんどの
  81 アプリケーションでは、長さ 1024 バイトのバッファで十分なはずである)。
  82
  83 関数呼び出しでサービスレコードの取得に成功すると、
  84 \fI*result\fP は \fIresult_buf\fP を指すように設定される。
  85 それ以外の場合は \fI*result\fP に NULL が設定される。
  86 .SH 返り値
  87 成功すると、これらの関数は 0 を返す。エラーの場合、「エラー」の節の
  88 リストにある正のエラー番号のいずれかを返す。
  89
  90 エラーの場合、レコードが見つからなかった場合 (\fBgetservbyname_r\fP(),
  91 \fBgetservbyaddr_r\fP()) やこれ以上レコードがない場合 (\fBgetservent_r\fP())、
  92 \fIresult\fP には NULL が設定される。
  93 .SH エラー
  94 .TP
  95 \fBENOENT\fP
  96 (\fBgetservent_r\fP())  データベースにこれ以上レコードがない。
  97 .TP
  98 \fBERANGE\fP
  99 \fIbuf\fP が小さすぎる。もっと大きなバッファにして
 100 (または \fIbuflen\fP を増やして) 再度呼び出すこと。
 101 .SH 準拠
 102 これらの関数は GNU による拡張である。
 103 他のシステムにも同様の名前の関数が存在する場合があるが、
 104 通常は関数の引き数が異なる。
 105 .SH 例
 106 以下のプログラムは、 \fBgetservbyport_r\fP() を使って、コマンド
 107 ライン引き数で指定されたポート番号とプロトコル名を持つ
 108 サービスレコードを取得する。
 109 三番目のコマンドライン引き数 (整数値) が指定された場合は、
 110 その値が \fIbuflen\fP の初期値として使用される。
 111 \fBgetservbyport_r\fP() がエラー \fBERANGE\fP で失敗すると、プログラムは
 112 より大きなバッファサイズで再度 \fBgetservbyport_r\fP を呼び出す。
 113 下記のシェルのセッションは実行例を示している。
 114 .in +4n
 115 .nf
 116
 117 $\fB ./a.out 7 tcp 1\fP
 118 ERANGE! Retrying with larger buffer
 119 getservbyport_r() returned: 0 (success)  (buflen=87)
 120 s_name=echo; s_proto=tcp; s_port=7; aliases=
 121 $\fB ./a.out 77777 tcp\fP
 122 getservbyport_r() returned: 0 (success)  (buflen=1024)
 123 Call failed/record not found
 124 .fi
 125 .in
 126 .SS プログラムのソース
 127 \&
 128 .nf
 129 #define _GNU_SOURCE
 130 #include <ctype.h>
 131 #include <netdb.h>
 132 #include <stdlib.h>
 133 #include <stdio.h>
 134 #include <errno.h>
 135 #include <string.h>
 136
 137 #define MAX_BUF 10000
 138
 139 int
 140 main(int argc, char *argv[])
 141 {
 142     int buflen, erange_cnt, port, s;
 143     struct servent result_buf;
 144     struct servent *result;
 145     char buf[MAX_BUF];
 146     char *protop;
 147     char **p;
 148
 149     if (argc < 3) {
 150         printf("Usage: %s port\-num proto\-name [buflen]\en", argv[0]);
 151         exit(EXIT_FAILURE);
 152     }
 153
 154     port = htons(atoi(argv[1]));
 155     protop = (strcmp(argv[2], "null") == 0 ||
 156               strcmp(argv[2], "NULL") == 0) ?  NULL : argv[2];
 157
 158     buflen = 1024;
 159     if (argc > 3)
 160         buflen = atoi(argv[3]);
 161
 162     if (buflen > MAX_BUF) {
 163         printf("Exceeded buffer limit (%d)\en", MAX_BUF);
 164         exit(EXIT_FAILURE);
 165     }
 166
 167     erange_cnt = 0;
 168     do {
 169         s = getservbyport_r(port, protop, &result_buf,
 170                      buf, buflen, &result);
 171         if (s == ERANGE) {
 172             if (erange_cnt == 0)
 173                 printf("ERANGE! Retrying with larger buffer\en");
 174             erange_cnt++;
 175
 176             /* Increment a byte at a time so we can see exactly
 177                what size buffer was required */
 178
 179             buflen++;
 180
 181             if (buflen > MAX_BUF) {
 182                 printf("Exceeded buffer limit (%d)\en", MAX_BUF);
 183                 exit(EXIT_FAILURE);
 184             }
 185         }
 186     } while (s == ERANGE);
 187
 188     printf("getservbyport_r() returned: %s  (buflen=%d)\en",
 189             (s == 0) ? "0 (success)" : (s == ENOENT) ? "ENOENT" :
 190             strerror(s), buflen);
 191
 192     if (s != 0 || result == NULL) {
 193         printf("Call failed/record not found\en");
 194         exit(EXIT_FAILURE);
 195     }
 196
 197     printf("s_name=%s; s_proto=%s; s_port=%d; aliases=",
 198                 result_buf.s_name, result_buf.s_proto,
 199                 ntohs(result_buf.s_port));
 200     for (p = result_buf.s_aliases; *p != NULL; p++)
 201         printf("%s ", *p);
 202     printf("\en");
 203
 204     exit(EXIT_SUCCESS);
 205 }
 206 .fi
 207 .SH 関連項目
 208 \fBgetservent\fP(3), \fBservices\fP(5)
 209 .SH この文書について
 210 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 211 である。プロジェクトの説明とバグ報告に関する情報は
 212 http://www.kernel.org/doc/man\-pages/ に書かれている。