getpeername

関数

接続先ソケットのアドレス情報を取得する。

DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

// WS2_32.dll
#include <windows.h>

INT getpeername(
    SOCKET s,
    SOCKADDR* name,
    INT* namelen
);

パラメーター

名前	型	方向	説明
s	SOCKET	in	接続済みの socket を識別するディスクリプタです。
name	SOCKADDR*	out	ピアのアドレスを受け取る SOCKADDR 構造体です。
namelen	INT*	inout	name パラメーターのサイズ(バイト単位)へのポインターです。

戻り値の型: INT

公式ドキュメント

getpeername 関数 (winsock.h) は、socket が接続されているピアのアドレスを取得します。

戻り値

エラーが発生しなかった場合、 getpeername は 0 を返します。それ以外の場合は SOCKET_ERROR が返され、 WSAGetLastError を呼び出すことで具体的なエラーコードを取得できます。

エラーコード	意味
WSANOTINITIALISED	この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。
WSAENETDOWN	ネットワークサブシステムに障害が発生しました。
WSAEFAULT	name または namelen パラメーターがユーザーアドレス空間の有効な領域内にないか、namelen パラメーターが小さすぎます。
WSAEINPROGRESS	ブロッキングを伴う Windows Sockets 1.1 の呼び出しが進行中であるか、サービスプロバイダーがコールバック関数を処理中です。
WSAENOTCONN	socket が接続されていません。
WSAENOTSOCK	そのディスクリプタは socket ではありません。

解説(Remarks)

getpeername 関数は、socket s に接続されているピアのアドレスを取得し、そのアドレスを name パラメーターで指定された SOCKADDR 構造体に格納します。この関数はあらゆるアドレスファミリで動作し、socket が接続されているアドレスを単純に返します。getpeername 関数は接続済みの socket に対してのみ使用できます。

データグラム socket の場合、以前の connect 呼び出しで指定されたピアのアドレスのみが返されます。以前の sendto 呼び出しで指定されたアドレスは、 getpeername では返されません。

呼び出し時には、namelen パラメーターには name バッファーのサイズ(バイト単位)が格納されています。戻り時には、namelen パラメーターには返された name パラメーターの実際のサイズ(バイト単位)が格納されます。

Windows Phone 8: この関数は、Windows Phone 8 以降の Windows Phone ストアアプリでサポートされています。

Windows 8.1 および Windows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされています。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WS2_32.dll
#include <windows.h>

INT getpeername(
    SOCKET s,
    SOCKADDR* name,
    INT* namelen
);

[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int getpeername(
    UIntPtr s,   // SOCKET
    IntPtr name,   // SOCKADDR* out
    ref int namelen   // INT* in/out
);

<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function getpeername(
    s As UIntPtr,   ' SOCKET
    name As IntPtr,   ' SOCKADDR* out
    ByRef namelen As Integer   ' INT* in/out
) As Integer
End Function

' s : SOCKET
' name : SOCKADDR* out
' namelen : INT* in/out
Declare PtrSafe Function getpeername Lib "ws2_32" ( _
    ByVal s As LongPtr, _
    ByVal name As LongPtr, _
    ByRef namelen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

getpeername = ctypes.windll.ws2_32.getpeername
getpeername.restype = ctypes.c_int
getpeername.argtypes = [
    ctypes.c_size_t,  # s : SOCKET
    ctypes.c_void_p,  # name : SOCKADDR* out
    ctypes.POINTER(ctypes.c_int),  # namelen : INT* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
getpeername = Fiddle::Function.new(
  lib['getpeername'],
  [
    Fiddle::TYPE_UINTPTR_T,  # s : SOCKET
    Fiddle::TYPE_VOIDP,  # name : SOCKADDR* out
    Fiddle::TYPE_VOIDP,  # namelen : INT* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ws2_32")]
extern "system" {
    fn getpeername(
        s: usize,  // SOCKET
        name: *mut SOCKADDR,  // SOCKADDR* out
        namelen: *mut i32  // INT* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int getpeername(UIntPtr s, IntPtr name, ref int namelen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_getpeername' -Namespace Win32 -PassThru
# $api::getpeername(s, name, namelen)

#uselib "WS2_32.dll"
#func global getpeername "getpeername" sptr, sptr, sptr
; getpeername s, varptr(name), varptr(namelen)   ; 戻り値は stat
; s : SOCKET -> "sptr"
; name : SOCKADDR* out -> "sptr"
; namelen : INT* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WS2_32.dll"
#cfunc global getpeername "getpeername" sptr, var, var
; res = getpeername(s, name, namelen)
; s : SOCKET -> "sptr"
; name : SOCKADDR* out -> "var"
; namelen : INT* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll"
#cfunc global getpeername "getpeername" sptr, sptr, sptr
; res = getpeername(s, varptr(name), varptr(namelen))
; s : SOCKET -> "sptr"
; name : SOCKADDR* out -> "sptr"
; namelen : INT* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。