manual/LDP_man-pages/release/man2/getpeername.2

   1 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
   2 .\" 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 .\"     @(#)getpeername.2       6.5 (Berkeley) 3/10/91
  33 .\"
  34 .\" Modified Sat Jul 24 16:37:50 1993 by Rik Faith <faith@cs.unc.edu>
  35 .\" Modified Thu Jul 30 14:37:50 1993 by Martin Schulze <joey@debian.org>
  36 .\" Modified Sun Mar 28 21:26:46 1999 by Andries Brouwer <aeb@cwi.nl>
  37 .\" Modified 17 Jul 2002, Michael Kerrisk <mtk.manpages@gmail.com>
  38 .\"     Added 'socket' to NAME, so that "man -k socket" will show this page.
  39 .\"
  40 .\" Japanese Version Copyright (c) 1997-1999 HANATAKA Shinya
  41 .\"         all rights reserved.
  42 .\" Translated Sat Apr  3 14:53:19 JST 1999
  43 .\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  44 .\" Updated Tue Nov 26 JST 2002 by Kentaro Shirakata <argrath@ub32.org>
  45 .\"
  46 .\"WORD:        connect                 接続
  47 .\"WORD:        peer                    相手
  48 .\"WORD:        socket                  ソケット
  49 .\"WORD:        buffer                  バッファ
  50 .\"WORD:        descriptor              ディスクリプタ
  51 .\"WORD:        argument                引き数
  52 .\"
  53 .TH GETPEERNAME 2 2008-12-03 "Linux" "Linux Programmer's Manual"
  54 .SH 名前
  55 getpeername \- 接続している相手ソケットの名前を取得する
  56 .SH 書式
  57 .B #include <sys/socket.h>
  58 .sp
  59 .BI "int getpeername(int " sockfd ", struct sockaddr *" addr \
  60 ", socklen_t *" addrlen );
  61 .SH 説明
  62 .BR getpeername ()
  63 は、ソケット(socket)
  64 .I sockfd
  65 に接続している相手のアドレスを、
  66 .I addr
  67 が指すバッファに格納して返す。
  68 .I addrlen
  69 引き数は、
  70 .I addr
  71 が指している領域のサイズに初期化しておかなければならない。
  72 関数が返る時には、
  73 .I addrlen
  74 には実際に返された名前のサイズが (バイト単位で) 格納される。
  75 提供されたバッファが小さすぎた場合には、名前は切り詰められる。
  76
  77 渡されたバッファが小さ過ぎた場合は、返されるアドレスの末尾が切り詰められる。
  78 この場合には、
  79 .I addrlen
  80 には、呼び出し時に指定された値よりも大きな値が格納される。
  81 .SH 返り値
  82 成功した場合は 0 が返される。エラーの場合は \-1 が返され、
  83 .I errno
  84 を適切に設定する。
  85 .SH エラー
  86 .TP
  87 .B EBADF
  88 引き数
  89 .I sockfd
  90 が有効なディスクリプタでない。
  91 .TP
  92 .B EFAULT
  93 .I addr
  94 引き数の指しているメモリが有効なプロセスのアドレス空間の
  95 一部でない。
  96 .TP
  97 .B EINVAL
  98 .I addrlen
  99 が不正である (例えば、負で場合など)。
 100 .TP
 101 .B ENOBUFS
 102 この操作を行なうのに十分な資源がシステムに存在しない。
 103 .TP
 104 .B ENOTCONN
 105 ソケットが接続していない。
 106 .TP
 107 .B ENOTSOCK
 108 引き数
 109 .I sockfd
 110 がソケットでなくてファイルである。
 111 .SH 準拠
 112 SVr4, 4.4BSD
 113 .RB ( getpeername ()
 114 関数は 4.2BSD で登場した), POSIX.1-2001.
 115 .SH 注意
 116 .BR getpeername ()
 117 の三番目の引き数は実際には
 118 .I `int *'
 119 である (4.x BSD, libc4, libc5 では
 120 このようになっている)。
 121 POSIX では紆余曲折を経て現在の
 122 .I socklen_t
 123 になっており、
 124 glibc でも
 125 .I socklen_t
 126 を使っている。
 127 .BR accept (2)
 128 も参照のこと。
 129 .SH 関連項目
 130 .BR accept (2),
 131 .BR bind (2),
 132 .BR getsockname (2),
 133 .BR ip (7),
 134 .BR socket (7),
 135 .BR unix (7)