release/man2/getpeername.2

   1 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\" %%%LICENSE_END
  33 .\"
  34 .\"     @(#)getpeername.2       6.5 (Berkeley) 3/10/91
  35 .\"
  36 .\" Modified Sat Jul 24 16:37:50 1993 by Rik Faith <faith@cs.unc.edu>
  37 .\" Modified Thu Jul 30 14:37:50 1993 by Martin Schulze <joey@debian.org>
  38 .\" Modified Sun Mar 28 21:26:46 1999 by Andries Brouwer <aeb@cwi.nl>
  39 .\" Modified 17 Jul 2002, Michael Kerrisk <mtk.manpages@gmail.com>
  40 .\"     Added 'socket' to NAME, so that "man -k socket" will show this page.
  41 .\"
  42 .\"*******************************************************************
  43 .\"
  44 .\" This file was generated with po4a. Translate the source file.
  45 .\"
  46 .\"*******************************************************************
  47 .TH GETPEERNAME 2 2013\-02\-12 Linux "Linux Programmer's Manual"
  48 .SH 名前
  49 getpeername \- 接続している相手ソケットの名前を取得する
  50 .SH 書式
  51 \fB#include <sys/socket.h>\fP
  52 .sp
  53 \fBint getpeername(int \fP\fIsockfd\fP\fB, struct sockaddr *\fP\fIaddr\fP\fB, socklen_t
  54 *\fP\fIaddrlen\fP\fB);\fP
  55 .SH 説明
  56 \fBgetpeername\fP()  は、ソケット(socket)  \fIsockfd\fP に接続している相手のアドレスを、 \fIaddr\fP
  57 が指すバッファに格納して返す。 \fIaddrlen\fP 引き数は、 \fIaddr\fP が指している領域のサイズに初期化しておかなければならない。
  58 関数が返る時には、 \fIaddrlen\fP には実際に返された名前のサイズが (バイト単位で) 格納される。
  59 提供されたバッファが小さすぎた場合には、名前は切り詰められる。
  60
  61 渡されたバッファが小さ過ぎた場合は、返されるアドレスの末尾が切り詰められる。 この場合には、 \fIaddrlen\fP
  62 には、呼び出し時に指定された値よりも大きな値が格納される。
  63 .SH 返り値
  64 成功した場合は 0 が返される。エラーの場合は \-1 が返され、 \fIerrno\fP が適切に設定される。
  65 .SH エラー
  66 .TP
  67 \fBEBADF\fP
  68 引き数 \fIsockfd\fP が有効なディスクリプタでない。
  69 .TP
  70 \fBEFAULT\fP
  71 \fIaddr\fP 引き数の指しているメモリが有効なプロセスのアドレス空間の 一部でない。
  72 .TP
  73 \fBEINVAL\fP
  74 \fIaddrlen\fP が不正である (例えば、負で場合など)。
  75 .TP
  76 \fBENOBUFS\fP
  77 この操作を行なうのに十分な資源がシステムに存在しない。
  78 .TP
  79 \fBENOTCONN\fP
  80 ソケットが接続していない。
  81 .TP
  82 \fBENOTSOCK\fP
  83 引き数 \fIsockfd\fP がソケットでなくてファイルである。
  84 .SH 準拠
  85 SVr4, 4.4BSD (\fBgetpeername\fP()  関数は 4.2BSD で登場した), POSIX.1\-2001.
  86 .SH 注意
  87 \fBgetpeername\fP()  の三番目の引き数は実際には \fI`int\ *'\fP である (4.x BSD, libc4, libc5 では
  88 このようになっている)。 POSIX では紆余曲折を経て現在の \fIsocklen_t\fP になっており、 glibc でも \fIsocklen_t\fP
  89 を使っている。 \fBaccept\fP(2)  も参照のこと。
  90
  91 ストリームソケットでは、 いったん \fBconnect\fP(2) が実行されると、 どのソケットも \fBgetpeername\fP()
  92 を使って相手ソケットのアドレスを取得できる。 一方、データグラムソケットはコネクションレスである (接続がない)。 データグラムソケットに対する
  93 \fBconnect\fP(2) の呼び出しは、 \fBwrite\fP(2) や \fBrecv\fP(2)
  94 で送信される出力データグラムの相手アドレスを設定するだけである。
  95 \fBconnect\fP(2) の呼び出し元は、 \fBgetpeername\fP()
  96 を使って、それ以前にそのソケットに設定された相手アドレスを取得することができる。 しかし、相手ソケットはこの情報を知らないので、 相手ソケットで
  97 \fBgetpeername\fP() を呼び出しても、 役に立つ情報は得られない (相手側でも \fBconnect\fP(2) が呼び出されている場合を除く)。
  98 なお、データグラムの受信側では \fBrecvfrom\fP(2) を使って送信元アドレスを 取得できることも覚えておいてほしい。
  99 .SH 関連項目
 100 \fBaccept\fP(2), \fBbind\fP(2), \fBgetsockname\fP(2), \fBip\fP(7), \fBsocket\fP(7),
 101 \fBunix\fP(7)
 102 .SH この文書について
 103 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 104 である。プロジェクトの説明とバグ報告に関する情報は
 105 http://www.kernel.org/doc/man\-pages/ に書かれている。