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

WSARecvEx

関数
メッセージ境界情報付きでソケットからデータを受信する。
DLLMSWSOCK.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT WSARecvEx(
    SOCKET s,
    LPSTR buf,
    INT len,
    INT* flags
);

パラメーター

名前方向説明
sSOCKETin接続済みソケットを識別する記述子です。
bufLPSTRout受信データを格納するバッファへのポインターです。
lenINTinbuf パラメーターが指すバッファの長さ (バイト単位) です。
flagsINT*inoutデータグラムソケットにおいて、メッセージが完全に受信されたか部分的に受信されたかを示すインジケーターです。

戻り値の型: INT

公式ドキュメント

WSARecvEx 関数 (mswsock.h) は、接続済みソケットまたはバインド済みのコネクションレスソケットからデータを受信します。

戻り値

エラーが発生しなかった場合、 WSARecvEx は受信したバイト数を返します。接続が閉じられている場合は 0 を返します。さらに、部分メッセージを受信した場合は flags パラメーターに MSG_PARTIAL ビットが設定されます。完全なメッセージを受信した場合、flagsMSG_PARTIAL は設定されません。

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

重要 ストリーム指向のトランスポートプロトコルでは、 WSARecvEx から戻る際に MSG_PARTIAL が設定されることはありません。この関数は、ストリームトランスポートプロトコルに対しては recv 関数と同一の動作をします。
エラーコード 意味
WSAECONNABORTED
タイムアウトまたはその他の障害により、仮想回線が終了しました。このソケットは使用できなくなるため、アプリケーションはソケットを閉じる必要があります。
WSAECONNRESET
リモート側がハードクローズまたは強制終了を実行したため、仮想回線がリセットされました。このソケットは使用できなくなるため、アプリケーションはソケットを閉じる必要があります。UDP データグラムソケットでは、このエラーは以前の送信操作が ICMP の「Port Unreachable (ポート到達不能)」メッセージを引き起こしたことを示します。
WSAEFAULT
buf パラメーターが、ユーザーアドレス空間の有効な領域に完全には含まれていません。
WSAEINPROGRESS
ブロッキングの Windows Sockets 1.1 呼び出しが進行中であるか、サービスプロバイダーがコールバック関数の処理中です。
WSAEINTR
(ブロッキング) 呼び出しが WSACancelBlockingCall 呼び出しによってキャンセルされました。
WSAEINVAL
ソケットが bind でバインドされていない、不明なフラグが指定された、SO_OOBINLINE が有効なソケットに対して MSG_OOB が指定された、または (バイトストリームソケットのみ) len が 0 または負の値でした。
WSAENETDOWN
ネットワークサブシステムに障害が発生しました。
WSAENETRESET
コネクション指向ソケットの場合、このエラーは、操作の進行中に keep-alive 動作が障害を検出し、接続が切断されたことを示します。データグラムソケットの場合、このエラーは Time To Live が満了したことを示します。
WSAENOTCONN
ソケットが接続されていません。
WSAENOTSOCK
記述子がソケットではありません。
WSAEOPNOTSUPP
MSG_OOB が指定されましたが、ソケットが SOCK_STREAM 型などのストリーム形式ではない、このソケットに関連付けられた通信ドメインで OOB データがサポートされていない、またはソケットが単方向で送信操作のみをサポートしています。
WSAESHUTDOWN
ソケットがシャットダウンされています。howSD_RECEIVE または SD_BOTH に設定して shutdown を呼び出した後のソケットに対しては、 WSARecvEx を使用することはできません。
WSAETIMEDOUT
ネットワーク障害、または相手側システムが応答しなかったため、接続が切断されました。
WSAEWOULDBLOCK
ソケットが非ブロッキングとしてマークされており、受信操作がブロックされる状況です。
WSANOTINITIALISED
この関数を使用する前に、 WSAStartup 呼び出しが成功している必要があります。

解説(Remarks)

Microsoft による Windows Sockets 2 の実装に含まれる WSARecvEx 関数は、より一般的な recv 関数とよく似ていますが、flags パラメーターが単一の特定の目的に使用される点が異なります。flags パラメーターは、メッセージ指向プロトコルを使用しているときに、部分メッセージと完全メッセージのどちらを受信したかを示すために使用されます。

flags パラメーターが指す値は、入力時には無視されます。したがって、WSARecvEx 関数にフラグを渡してその動作を変更することはできません。flags パラメーターが指す値は、出力時に設定されます。これは、入力時の flags パラメーターが指す値によって関数の動作を変更できる recv 関数や WSARecv 関数とは異なる点です。

WSARecvEx 関数と recv 関数は、ストリーム指向プロトコルに対しては同一の動作をします。

flags パラメーターは、部分メッセージが受信される次の 2 つの一般的な状況に対応します。

部分メッセージを受信した場合、WSARecvEx から戻る際に flags パラメーターが指す値に MSG_PARTIAL ビットが設定されます。完全なメッセージを受信した場合、flags パラメーターが指す値に MSG_PARTIAL は設定されません。

recv 関数は、 WSARecvEx 関数や WSARecv 関数とは異なり、メッセージ指向トランスポートプロトコルにおいて呼び出しごとに常に 1 つのメッセージを受信します。また、recv 関数には、受信したデータが部分メッセージにすぎないことをアプリケーションに伝える手段がありません。アプリケーションは、recv の各呼び出し後にエラーコード WSAEMSGSIZE を確認することで、メッセージが部分的か完全かをチェックする独自のプロトコルを構築する必要があります。アプリケーションバッファが送信されたデータより小さい場合、メッセージのうち収まる分だけがユーザーバッファにコピーされ、recv はエラーコード WSAEMSGSIZE とともに戻ります。その後の recv 呼び出しでメッセージの次の部分を取得します。

メッセージ指向トランスポートプロトコル向けに書かれたアプリケーションは、アプリケーションのデータ転送プロトコルによってメッセージサイズが保証されていない場合、この可能性を考慮してコーディングする必要があります。アプリケーションは recv を使用してプロトコルを自身で管理することができます。あるいは、WSARecvEx を使用して flags パラメーターに MSG_PARTIAL ビットが設定されているかどうかを確認することもできます。

WSARecvEx 関数は、非常に大きなメッセージが段階的に到着する場合に、受信したメッセージが部分的か完全かを確認するための、より効果的な方法を開発者に提供します。たとえば、アプリケーションが 1 メガバイトのメッセージを送信する場合、トランスポートプロトコルはそれを物理ネットワーク経由で送信するためにメッセージを分割する必要があります。受信側のトランスポートプロトコルがメッセージ内のすべてのデータをバッファリングすることは理論的には可能ですが、これはリソースの観点で非常にコストがかかります。代わりに WSARecvEx を使用することで、オーバーヘッドを最小限に抑え、アプリケーションベースのプロトコルを不要にできます。

注意 あるスレッドによって開始されたすべての I/O は、そのスレッドが終了すると取り消されます。オーバーラップソケットの場合、操作が完了する前にスレッドが閉じられると、保留中の非同期操作が失敗する可能性があります。詳細については ExitThread 関数を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

INT WSARecvEx(
    SOCKET s,
    LPSTR buf,
    INT len,
    INT* flags
);
[DllImport("MSWSOCK.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSARecvEx(
    UIntPtr s,   // SOCKET
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder buf,   // LPSTR out
    int len,   // INT
    ref int flags   // INT* in/out
);
<DllImport("MSWSOCK.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSARecvEx(
    s As UIntPtr,   ' SOCKET
    <MarshalAs(UnmanagedType.LPStr)> buf As System.Text.StringBuilder,   ' LPSTR out
    len As Integer,   ' INT
    ByRef flags As Integer   ' INT* in/out
) As Integer
End Function
' s : SOCKET
' buf : LPSTR out
' len : INT
' flags : INT* in/out
Declare PtrSafe Function WSARecvEx Lib "mswsock" ( _
    ByVal s As LongPtr, _
    ByVal buf As String, _
    ByVal len As Long, _
    ByRef flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSARecvEx = ctypes.windll.mswsock.WSARecvEx
WSARecvEx.restype = ctypes.c_int
WSARecvEx.argtypes = [
    ctypes.c_size_t,  # s : SOCKET
    wintypes.LPSTR,  # buf : LPSTR out
    ctypes.c_int,  # len : INT
    ctypes.POINTER(ctypes.c_int),  # flags : INT* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	mswsock = windows.NewLazySystemDLL("MSWSOCK.dll")
	procWSARecvEx = mswsock.NewProc("WSARecvEx")
)

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

extern "mswsock" fn WSARecvEx(
    s: usize, // SOCKET
    buf: [*c]u8, // LPSTR out
    len: i32, // INT
    flags: [*c]i32 // INT* in/out
) callconv(std.os.windows.WINAPI) i32;
proc WSARecvEx(
    s: uint,  # SOCKET
    buf: ptr char,  # LPSTR out
    len: int32,  # INT
    flags: ptr int32  # INT* in/out
): int32 {.importc: "WSARecvEx", stdcall, dynlib: "MSWSOCK.dll".}
pragma(lib, "mswsock");
extern(Windows)
int WSARecvEx(
    size_t s,   // SOCKET
    char* buf,   // LPSTR out
    int len,   // INT
    int* flags   // INT* in/out
);
ccall((:WSARecvEx, "MSWSOCK.dll"), stdcall, Int32,
      (Csize_t, Ptr{UInt8}, Int32, Ptr{Int32}),
      s, buf, len, flags)
# s : SOCKET -> Csize_t
# buf : LPSTR out -> Ptr{UInt8}
# len : INT -> Int32
# flags : INT* in/out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WSARecvEx(
    uintptr_t s,
    char* buf,
    int32_t len,
    int32_t* flags);
]]
local mswsock = ffi.load("mswsock")
-- mswsock.WSARecvEx(s, buf, len, flags)
-- s : SOCKET
-- buf : LPSTR out
-- len : INT
-- flags : INT* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('MSWSOCK.dll');
const WSARecvEx = lib.func('__stdcall', 'WSARecvEx', 'int32_t', ['uintptr_t', 'char *', 'int32_t', 'int32_t *']);
// WSARecvEx(s, buf, len, flags)
// s : SOCKET -> 'uintptr_t'
// buf : LPSTR out -> 'char *'
// len : INT -> 'int32_t'
// flags : INT* in/out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("MSWSOCK.dll", {
  WSARecvEx: { parameters: ["usize", "buffer", "i32", "pointer"], result: "i32" },
});
// lib.symbols.WSARecvEx(s, buf, len, flags)
// s : SOCKET -> "usize"
// buf : LPSTR out -> "buffer"
// len : INT -> "i32"
// flags : INT* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WSARecvEx(
    size_t s,
    char* buf,
    int32_t len,
    int32_t* flags);
C, "MSWSOCK.dll");
// $ffi->WSARecvEx(s, buf, len, flags);
// s : SOCKET
// buf : LPSTR out
// len : INT
// flags : INT* in/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 Mswsock extends StdCallLibrary {
    Mswsock INSTANCE = Native.load("mswsock", Mswsock.class);
    int WSARecvEx(
        long s,   // SOCKET
        byte[] buf,   // LPSTR out
        int len,   // INT
        IntByReference flags   // INT* in/out
    );
}
@[Link("mswsock")]
lib LibMSWSOCK
  fun WSARecvEx = WSARecvEx(
    s : LibC::SizeT,   # SOCKET
    buf : UInt8*,   # LPSTR out
    len : Int32,   # INT
    flags : Int32*   # INT* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WSARecvExNative = Int32 Function(UintPtr, Pointer<Utf8>, Int32, Pointer<Int32>);
typedef WSARecvExDart = int Function(int, Pointer<Utf8>, int, Pointer<Int32>);
final WSARecvEx = DynamicLibrary.open('MSWSOCK.dll')
    .lookupFunction<WSARecvExNative, WSARecvExDart>('WSARecvEx');
// s : SOCKET -> UintPtr
// buf : LPSTR out -> Pointer<Utf8>
// len : INT -> Int32
// flags : INT* in/out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSARecvEx(
  s: NativeUInt;   // SOCKET
  buf: PAnsiChar;   // LPSTR out
  len: Integer;   // INT
  flags: Pointer   // INT* in/out
): Integer; stdcall;
  external 'MSWSOCK.dll' name 'WSARecvEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSARecvEx"
  c_WSARecvEx :: CUIntPtr -> CString -> Int32 -> Ptr Int32 -> IO Int32
-- s : SOCKET -> CUIntPtr
-- buf : LPSTR out -> CString
-- len : INT -> Int32
-- flags : INT* in/out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsarecvex =
  foreign "WSARecvEx"
    (size_t @-> string @-> int32_t @-> (ptr int32_t) @-> returning int32_t)
(* s : SOCKET -> size_t *)
(* buf : LPSTR out -> string *)
(* len : INT -> int32_t *)
(* flags : INT* in/out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mswsock (t "MSWSOCK.dll"))
(cffi:use-foreign-library mswsock)

(cffi:defcfun ("WSARecvEx" wsarecv-ex :convention :stdcall) :int32
  (s :uint64)   ; SOCKET
  (buf :pointer)   ; LPSTR out
  (len :int32)   ; INT
  (flags :pointer))   ; INT* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSARecvEx = Win32::API::More->new('MSWSOCK',
    'int WSARecvEx(WPARAM s, LPSTR buf, int len, LPVOID flags)');
# my $ret = $WSARecvEx->Call($s, $buf, $len, $flags);
# s : SOCKET -> WPARAM
# buf : LPSTR out -> LPSTR
# len : INT -> int
# flags : INT* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目