Win32 API 日本語リファレンス
ホームNetworking.WinSock › WSADuplicateSocketA

WSADuplicateSocketA

関数
別プロセスで共有可能なソケット情報を複製する。
DLLWS2_32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

// WS2_32.dll  (ANSI / -A)
#include <windows.h>

INT WSADuplicateSocketA(
    SOCKET s,
    DWORD dwProcessId,
    WSAPROTOCOL_INFOA* lpProtocolInfo
);

パラメーター

名前方向説明
sSOCKETinローカルソケットを識別する記述子。
dwProcessIdDWORDin複製されたソケットが使用される対象プロセスのプロセス識別子。
lpProtocolInfoWSAPROTOCOL_INFOA*outクライアントによって割り当てられた、 WSAPROTOCOL_INFO 構造体を格納するのに十分な大きさのバッファーへのポインター。サービスプロバイダーは、プロトコル情報構造体の内容をこのバッファーにコピーします。

戻り値の型: INT

公式ドキュメント

WSADuplicateSocket 関数は、共有ソケット用の新しいソケット記述子を作成するために使用できる WSAPROTOCOL_INFO 構造体を返します。WSADuplicateSocket 関数は、QOS 対応のソケットに対しては使用できません。(ANSI)

戻り値

エラーが発生しなかった場合、 WSADuplicateSocket はゼロを返します。それ以外の場合は SOCKET_ERROR の値が返され、 WSAGetLastError を呼び出すことで特定のエラーコードを取得できます。

エラーコード 意味
WSANOTINITIALISED
この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。
WSAENETDOWN
ネットワークサブシステムが失敗しました。
WSAEINVAL
指定されたパラメーターのいずれかが無効であることを示します。
WSAEINPROGRESS
ブロッキングする Windows Sockets 1.1 の呼び出しが進行中であるか、サービスプロバイダーがまだコールバック関数を処理しています。
WSAEMFILE
使用可能なソケット記述子がこれ以上ありません。
WSAENOBUFS
使用可能なバッファー領域がありません。ソケットを作成できません。
WSAENOTSOCK
記述子がソケットではありません。
WSAEFAULT
lpProtocolInfo パラメーターが、ユーザーアドレス空間の有効な部分ではありません。

解説(Remarks)

WSADuplicateSocket 関数は、プロセス間でのソケット共有を可能にするために使用されます。ソースプロセスは WSADuplicateSocket を呼び出して特別な WSAPROTOCOL_INFO 構造体を取得します。そして、何らかのプロセス間通信 (IPC) メカニズムを使用してこの構造体の内容を対象プロセスに渡し、対象プロセスはそれを WSASocket の呼び出しで使用して、複製されたソケットの記述子を取得します。この特別な WSAPROTOCOL_INFO 構造体は、対象プロセスによって一度だけ使用できます。

ソケット記述子はプロセス内のすべてのスレッドで有効であるため、WSADuplicateSocket 関数を使用せずに、指定されたプロセス内のスレッド間でソケットを共有できます。

共有ソケットを確立して引き渡す方法の 1 つを次の表に示します。

ソースプロセス IPC 宛先プロセス
1) WSASocketWSAConnect
2) 対象プロセス識別子を要求する ==>
3) プロセス識別子の要求を受信して応答する
4) プロセス識別子を受信する <==
5) WSADuplicateSocket を呼び出して特別な WSAPROTOCOL_INFO 構造体を取得する
6) WSAPROTOCOL_INFO 構造体を対象に送信する
==> 7) WSAPROTOCOL_INFO 構造体を受信する
8) WSASocket を呼び出して共有ソケット記述子を作成する。
9) データ交換に共有ソケットを使用する
10) closesocket <==

共有ソケットを参照する記述子は、I/O に対して独立して使用できます。ただし、Windows Sockets インターフェイスはいかなる種類のアクセス制御も実装していないため、共有ソケットに対する操作の調整は関係するプロセスに委ねられます。共有ソケットは通常、ソケットの作成と接続の確立を担当する 1 つのプロセスと、情報交換を担当する他のプロセスを持つために使用されます。

ソケット記述子は複製されますが実際のソケットは複製されないため、ソケットに関連付けられたすべての状態情報はすべての記述子間で共通に保持されます。たとえば、ある記述子を使用して実行された setsockopt 操作は、その後いずれかまたはすべての記述子からの getsockopt で参照できます。ソースプロセスと宛先プロセスの両方が、それぞれの WSASocket 関数呼び出しに同じフラグを渡す必要があります。ソースプロセスが socket 関数を使用してソケットを作成した場合、宛先プロセスはその WSASocket 関数呼び出しに WSA_FLAG_OVERLAPPED フラグを渡す必要があります。プロセスは複製されたソケットに対して closesocket を呼び出すことができ、その記述子は解放されます。ただし、基になるソケットは、最後に残った記述子によって closesocket が呼び出されるまで開いたままになります。

共有ソケットに関する通知は、 WSAAsyncSelect および WSAEventSelect の通常の制約に従います。共有記述子のいずれかを使用してこれらの呼び出しのいずれかを発行すると、どの記述子を使用してその登録を行ったかにかかわらず、ソケットに対する以前のイベント登録が取り消されます。したがって、共有ソケットは FD_READ イベントをプロセス A に、FD_WRITE イベントをプロセス B に配信することはできません。このような緊密な調整が必要な状況では、別々のプロセスではなくスレッドを使用することをお勧めします。

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

メモ

winsock2.h ヘッダーは、WSADuplicateSocket を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、関数プロトタイプの規約 を参照してください。

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

各言語での呼び出し定義

// WS2_32.dll  (ANSI / -A)
#include <windows.h>

INT WSADuplicateSocketA(
    SOCKET s,
    DWORD dwProcessId,
    WSAPROTOCOL_INFOA* lpProtocolInfo
);
[DllImport("WS2_32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int WSADuplicateSocketA(
    UIntPtr s,   // SOCKET
    uint dwProcessId,   // DWORD
    IntPtr lpProtocolInfo   // WSAPROTOCOL_INFOA* out
);
<DllImport("WS2_32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSADuplicateSocketA(
    s As UIntPtr,   ' SOCKET
    dwProcessId As UInteger,   ' DWORD
    lpProtocolInfo As IntPtr   ' WSAPROTOCOL_INFOA* out
) As Integer
End Function
' s : SOCKET
' dwProcessId : DWORD
' lpProtocolInfo : WSAPROTOCOL_INFOA* out
Declare PtrSafe Function WSADuplicateSocketA Lib "ws2_32" ( _
    ByVal s As LongPtr, _
    ByVal dwProcessId As Long, _
    ByVal lpProtocolInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSADuplicateSocketA = ctypes.windll.ws2_32.WSADuplicateSocketA
WSADuplicateSocketA.restype = ctypes.c_int
WSADuplicateSocketA.argtypes = [
    ctypes.c_size_t,  # s : SOCKET
    wintypes.DWORD,  # dwProcessId : DWORD
    ctypes.c_void_p,  # lpProtocolInfo : WSAPROTOCOL_INFOA* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSADuplicateSocketA = Fiddle::Function.new(
  lib['WSADuplicateSocketA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # s : SOCKET
    -Fiddle::TYPE_INT,  # dwProcessId : DWORD
    Fiddle::TYPE_VOIDP,  # lpProtocolInfo : WSAPROTOCOL_INFOA* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "ws2_32")]
extern "system" {
    fn WSADuplicateSocketA(
        s: usize,  // SOCKET
        dwProcessId: u32,  // DWORD
        lpProtocolInfo: *mut WSAPROTOCOL_INFOA  // WSAPROTOCOL_INFOA* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WS2_32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern int WSADuplicateSocketA(UIntPtr s, uint dwProcessId, IntPtr lpProtocolInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSADuplicateSocketA' -Namespace Win32 -PassThru
# $api::WSADuplicateSocketA(s, dwProcessId, lpProtocolInfo)
#uselib "WS2_32.dll"
#func global WSADuplicateSocketA "WSADuplicateSocketA" sptr, sptr, sptr
; WSADuplicateSocketA s, dwProcessId, varptr(lpProtocolInfo)   ; 戻り値は stat
; s : SOCKET -> "sptr"
; dwProcessId : DWORD -> "sptr"
; lpProtocolInfo : WSAPROTOCOL_INFOA* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WS2_32.dll"
#cfunc global WSADuplicateSocketA "WSADuplicateSocketA" sptr, int, var
; res = WSADuplicateSocketA(s, dwProcessId, lpProtocolInfo)
; s : SOCKET -> "sptr"
; dwProcessId : DWORD -> "int"
; lpProtocolInfo : WSAPROTOCOL_INFOA* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT WSADuplicateSocketA(SOCKET s, DWORD dwProcessId, WSAPROTOCOL_INFOA* lpProtocolInfo)
#uselib "WS2_32.dll"
#cfunc global WSADuplicateSocketA "WSADuplicateSocketA" intptr, int, var
; res = WSADuplicateSocketA(s, dwProcessId, lpProtocolInfo)
; s : SOCKET -> "intptr"
; dwProcessId : DWORD -> "int"
; lpProtocolInfo : WSAPROTOCOL_INFOA* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSADuplicateSocketA = ws2_32.NewProc("WSADuplicateSocketA")
)

// s (SOCKET), dwProcessId (DWORD), lpProtocolInfo (WSAPROTOCOL_INFOA* out)
r1, _, err := procWSADuplicateSocketA.Call(
	uintptr(s),
	uintptr(dwProcessId),
	uintptr(lpProtocolInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function WSADuplicateSocketA(
  s: NativeUInt;   // SOCKET
  dwProcessId: DWORD;   // DWORD
  lpProtocolInfo: Pointer   // WSAPROTOCOL_INFOA* out
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSADuplicateSocketA';
result := DllCall("WS2_32\WSADuplicateSocketA"
    , "UPtr", s   ; SOCKET
    , "UInt", dwProcessId   ; DWORD
    , "Ptr", lpProtocolInfo   ; WSAPROTOCOL_INFOA* out
    , "Int")   ; return: INT
●WSADuplicateSocketA(s, dwProcessId, lpProtocolInfo) = DLL("WS2_32.dll", "int WSADuplicateSocketA(int, dword, void*)")
# 呼び出し: WSADuplicateSocketA(s, dwProcessId, lpProtocolInfo)
# s : SOCKET -> "int"
# dwProcessId : DWORD -> "dword"
# lpProtocolInfo : WSAPROTOCOL_INFOA* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ws2_32" fn WSADuplicateSocketA(
    s: usize, // SOCKET
    dwProcessId: u32, // DWORD
    lpProtocolInfo: [*c]WSAPROTOCOL_INFOA // WSAPROTOCOL_INFOA* out
) callconv(std.os.windows.WINAPI) i32;
proc WSADuplicateSocketA(
    s: uint,  # SOCKET
    dwProcessId: uint32,  # DWORD
    lpProtocolInfo: ptr WSAPROTOCOL_INFOA  # WSAPROTOCOL_INFOA* out
): int32 {.importc: "WSADuplicateSocketA", stdcall, dynlib: "WS2_32.dll".}
pragma(lib, "ws2_32");
extern(Windows)
int WSADuplicateSocketA(
    size_t s,   // SOCKET
    uint dwProcessId,   // DWORD
    WSAPROTOCOL_INFOA* lpProtocolInfo   // WSAPROTOCOL_INFOA* out
);
ccall((:WSADuplicateSocketA, "WS2_32.dll"), stdcall, Int32,
      (Csize_t, UInt32, Ptr{WSAPROTOCOL_INFOA}),
      s, dwProcessId, lpProtocolInfo)
# s : SOCKET -> Csize_t
# dwProcessId : DWORD -> UInt32
# lpProtocolInfo : WSAPROTOCOL_INFOA* out -> Ptr{WSAPROTOCOL_INFOA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WSADuplicateSocketA(
    uintptr_t s,
    uint32_t dwProcessId,
    void* lpProtocolInfo);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.WSADuplicateSocketA(s, dwProcessId, lpProtocolInfo)
-- s : SOCKET
-- dwProcessId : DWORD
-- lpProtocolInfo : WSAPROTOCOL_INFOA* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const WSADuplicateSocketA = lib.func('__stdcall', 'WSADuplicateSocketA', 'int32_t', ['uintptr_t', 'uint32_t', 'void *']);
// WSADuplicateSocketA(s, dwProcessId, lpProtocolInfo)
// s : SOCKET -> 'uintptr_t'
// dwProcessId : DWORD -> 'uint32_t'
// lpProtocolInfo : WSAPROTOCOL_INFOA* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  WSADuplicateSocketA: { parameters: ["usize", "u32", "pointer"], result: "i32" },
});
// lib.symbols.WSADuplicateSocketA(s, dwProcessId, lpProtocolInfo)
// s : SOCKET -> "usize"
// dwProcessId : DWORD -> "u32"
// lpProtocolInfo : WSAPROTOCOL_INFOA* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WSADuplicateSocketA(
    size_t s,
    uint32_t dwProcessId,
    void* lpProtocolInfo);
C, "WS2_32.dll");
// $ffi->WSADuplicateSocketA(s, dwProcessId, lpProtocolInfo);
// s : SOCKET
// dwProcessId : DWORD
// lpProtocolInfo : WSAPROTOCOL_INFOA* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Ws2_32 extends StdCallLibrary {
    Ws2_32 INSTANCE = Native.load("ws2_32", Ws2_32.class, W32APIOptions.ASCII_OPTIONS);
    int WSADuplicateSocketA(
        long s,   // SOCKET
        int dwProcessId,   // DWORD
        Pointer lpProtocolInfo   // WSAPROTOCOL_INFOA* out
    );
}
@[Link("ws2_32")]
lib LibWS2_32
  fun WSADuplicateSocketA = WSADuplicateSocketA(
    s : LibC::SizeT,   # SOCKET
    dwProcessId : UInt32,   # DWORD
    lpProtocolInfo : WSAPROTOCOL_INFOA*   # WSAPROTOCOL_INFOA* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WSADuplicateSocketANative = Int32 Function(UintPtr, Uint32, Pointer<Void>);
typedef WSADuplicateSocketADart = int Function(int, int, Pointer<Void>);
final WSADuplicateSocketA = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<WSADuplicateSocketANative, WSADuplicateSocketADart>('WSADuplicateSocketA');
// s : SOCKET -> UintPtr
// dwProcessId : DWORD -> Uint32
// lpProtocolInfo : WSAPROTOCOL_INFOA* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSADuplicateSocketA(
  s: NativeUInt;   // SOCKET
  dwProcessId: DWORD;   // DWORD
  lpProtocolInfo: Pointer   // WSAPROTOCOL_INFOA* out
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSADuplicateSocketA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSADuplicateSocketA"
  c_WSADuplicateSocketA :: CUIntPtr -> Word32 -> Ptr () -> IO Int32
-- s : SOCKET -> CUIntPtr
-- dwProcessId : DWORD -> Word32
-- lpProtocolInfo : WSAPROTOCOL_INFOA* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsaduplicatesocketa =
  foreign "WSADuplicateSocketA"
    (size_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* s : SOCKET -> size_t *)
(* dwProcessId : DWORD -> uint32_t *)
(* lpProtocolInfo : WSAPROTOCOL_INFOA* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ws2_32 (t "WS2_32.dll"))
(cffi:use-foreign-library ws2_32)

(cffi:defcfun ("WSADuplicateSocketA" wsaduplicate-socket-a :convention :stdcall) :int32
  (s :uint64)   ; SOCKET
  (dw-process-id :uint32)   ; DWORD
  (lp-protocol-info :pointer))   ; WSAPROTOCOL_INFOA* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSADuplicateSocketA = Win32::API::More->new('WS2_32',
    'int WSADuplicateSocketA(WPARAM s, DWORD dwProcessId, LPVOID lpProtocolInfo)');
# my $ret = $WSADuplicateSocketA->Call($s, $dwProcessId, $lpProtocolInfo);
# s : SOCKET -> WPARAM
# dwProcessId : DWORD -> DWORD
# lpProtocolInfo : WSAPROTOCOL_INFOA* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目
使用する型