recvfrom
関数シグネチャ
// WS2_32.dll
#include <windows.h>
INT recvfrom(
SOCKET s,
LPSTR buf,
INT len,
INT flags,
SOCKADDR* from, // optional
INT* fromlen // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| s | SOCKET | in | バインドされた socket を識別するディスクリプタです。 |
| buf | LPSTR | out | 受信データを格納するためのバッファです。 |
| len | INT | in | buf パラメーターが指すバッファの長さ(バイト単位)です。 |
| flags | INT | in | 関連付けられた socket に指定されたオプションに加えて、関数呼び出しの動作を変更するオプションのセットです。詳細は以下の「解説」を参照してください。 |
| from | SOCKADDR* | outoptional | 戻り時に送信元アドレスを保持する sockaddr 構造体内のバッファへの省略可能なポインターです。 |
| fromlen | INT* | inoutoptional | from パラメーターが指すバッファのサイズ(バイト単位)への省略可能なポインターです。 |
戻り値の型: INT
公式ドキュメント
recvfrom 関数はデータグラムを受信し、その送信元アドレスを格納します。
戻り値
エラーが発生しない場合、 recvfrom は受信したバイト数を返します。接続が正常にクローズされた場合、戻り値は 0 です。それ以外の場合は SOCKET_ERROR が返され、 WSAGetLastError を呼び出すことで具体的なエラーコードを取得できます。
| エラーコード | 意味 |
|---|---|
| この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。 | |
| ネットワークサブシステムに障害が発生しました。 | |
| buf または from パラメーターが指すバッファがユーザーアドレス空間内にないか、fromlen パラメーターが小さすぎて相手先アドレスの送信元アドレスを格納できません。 | |
| (ブロッキング)呼び出しが WSACancelBlockingCall によってキャンセルされました。 | |
| ブロッキングの Windows Sockets 1.1 呼び出しが進行中であるか、サービスプロバイダーがコールバック関数をまだ処理中です。 | |
| socket が bind でバインドされていないか、不明なフラグが指定されたか、SO_OOBINLINE が有効な socket に対して MSG_OOB が指定されたか、または(バイトストリーム型の socket のみ)len が 0 または負の値でした。 | |
| socket が接続されています。この関数は、socket がコネクション指向かコネクションレスかにかかわらず、接続済みの socket では使用できません。 | |
| データグラム socket の場合、このエラーは TTL(time to live)が期限切れになったことを示します。 | |
| s パラメーターのディスクリプタが socket ではありません。 | |
| MSG_OOB が指定されましたが、socket が SOCK_STREAM 型などのストリーム型ではないか、この socket に関連付けられた通信ドメインで OOB データがサポートされていないか、または socket が単方向で送信操作のみをサポートしています。 | |
| socket がシャットダウンされました。how を SD_RECEIVE または SD_BOTH に設定して shutdown を呼び出した後は、その socket で recvfrom を実行できません。 | |
| socket が非ブロッキングとしてマークされており、 recvfrom 操作がブロックされる状況です。 | |
| メッセージが大きすぎて buf パラメーターが指すバッファに収まらず、切り詰められました。 | |
| ネットワーク障害のため、または相手側のシステムが通知なしにダウンしたため、接続が切断されました。 | |
| リモート側がハードクローズまたはアボートクローズを実行したことにより、仮想回線がリセットされました。アプリケーションは socket をクローズする必要があります。この socket はもう使用できません。UDP データグラム socket では、このエラーは以前の送信操作が ICMP Port Unreachable メッセージを引き起こしたことを示します。 |
解説(Remarks)
recvfrom 関数は、接続済みおよび未接続の両方の socket で受信データを読み取り、そのデータの送信元アドレスを取得します。この関数は通常、コネクションレスの socket で使用されます。socket のローカルアドレスが既知である必要があります。サーバーアプリケーションでは、通常これは bind によって明示的に行われます。クライアントアプリケーションでは明示的なバインドは推奨されません。この関数を使用するクライアントアプリケーションでは、 sendto、 WSASendTo、または WSAJoinLeaf を通じて、socket がローカルアドレスに暗黙的にバインドされる場合があります。
SOCK_STREAM 型などのストリーム指向の socket では、 recvfrom の呼び出しは、指定されたバッファのサイズを上限として、現在利用可能なだけの情報を返します。socket が OOB データのインライン受信(socket オプション SO_OOBINLINE)用に構成されており、OOB データが未読の場合は、OOB データのみが返されます。アプリケーションは ioctlsocket または WSAIoctl の SIOCATMARK コマンドを使用して、読み取るべき OOB データがまだ残っているかどうかを判断できます。コネクション指向の socket では、from および fromlen パラメーターは無視されます。
メッセージ指向の socket では、指定されたバッファのサイズを上限として、最初にキューに入れられたメッセージからデータが取り出されます。データグラムまたはメッセージが指定されたバッファより大きい場合、バッファはデータグラムの先頭部分で満たされ、 recvfrom はエラー WSAEMSGSIZE を生成します。信頼性のないプロトコル(例: UDP)では、超過分のデータは失われます。UDP の場合、受信したパケットにデータが含まれない(空の)とき、recvfrom 関数の戻り値は 0 になります。
from パラメーターが非ゼロで、socket がコネクション指向でない場合(例: SOCK_DGRAM 型)、データを送信した相手のネットワークアドレスが対応する sockaddr 構造体にコピーされます。fromlen が指す値はこの構造体のサイズに初期化され、戻り時には sockaddr 構造体に格納された実際のアドレスのサイズを示すように変更されます。
socket で受信データが利用できない場合、socket が非ブロッキングでない限り、 recvfrom 関数はブロックし、MSG_PARTIAL フラグが設定されていない WSARecv に定義されたブロッキング規則に従ってデータの到着を待ちます。非ブロッキングの場合は SOCKET_ERROR が返され、エラーコードは WSAEWOULDBLOCK に設定されます。 select、 WSAAsyncSelect、または WSAEventSelect を使用して、追加のデータがいつ到着するかを判断できます。
socket がコネクション指向で、リモート側が接続を正常にシャットダウンした場合、 recvfrom の呼び出しは受信バイト数 0 で直ちに完了します。接続がリセットされた場合、 recvfrom はエラー WSAECONNRESET で失敗します。
flags パラメーターを使用すると、関連付けられた socket に指定されたオプションに加えて、関数呼び出しの動作に影響を与えることができます。この関数のセマンティクスは、socket オプションと flags パラメーターによって決まります。後者は、次の値のいずれかをビット単位の OR 演算子で組み合わせて構成します。
| 値 | 意味 |
|---|---|
| MSG_PEEK | 受信データをのぞき見します。データはバッファにコピーされますが、入力キューからは削除されません。 |
| MSG_OOB | 帯域外(OOB: Out Of Band)データを処理します。 |
サンプルコード
次の例は recvfrom 関数の使用方法を示しています。#ifndef UNICODE
#define UNICODE
#endif
#define WIN32_LEAN_AND_MEAN
#include <winsock2.h>
#include <Ws2tcpip.h>
#include <stdio.h>
// Link with ws2_32.lib
#pragma comment(lib, "Ws2_32.lib")
int main()
{
int iResult = 0;
WSADATA wsaData;
SOCKET RecvSocket;
struct sockaddr_in RecvAddr;
unsigned short Port = 27015;
char RecvBuf[1024];
int BufLen = 1024;
struct sockaddr_in SenderAddr;
int SenderAddrSize = sizeof (SenderAddr);
//-----------------------------------------------
// Initialize Winsock
iResult = WSAStartup(MAKEWORD(2, 2), &wsaData);
if (iResult != NO_ERROR) {
wprintf(L"WSAStartup failed with error %d\n", iResult);
return 1;
}
//-----------------------------------------------
// Create a receiver socket to receive datagrams
RecvSocket = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
if (RecvSocket == INVALID_SOCKET) {
wprintf(L"socket failed with error %d\n", WSAGetLastError());
return 1;
}
//-----------------------------------------------
// Bind the socket to any address and the specified port.
RecvAddr.sin_family = AF_INET;
RecvAddr.sin_port = htons(Port);
RecvAddr.sin_addr.s_addr = htonl(INADDR_ANY);
iResult = bind(RecvSocket, (SOCKADDR *) & RecvAddr, sizeof (RecvAddr));
if (iResult != 0) {
wprintf(L"bind failed with error %d\n", WSAGetLastError());
return 1;
}
//-----------------------------------------------
// Call the recvfrom function to receive datagrams
// on the bound socket.
wprintf(L"Receiving datagrams...\n");
iResult = recvfrom(RecvSocket,
RecvBuf, BufLen, 0, (SOCKADDR *) & SenderAddr, &SenderAddrSize);
if (iResult == SOCKET_ERROR) {
wprintf(L"recvfrom failed with error %d\n", WSAGetLastError());
}
//-----------------------------------------------
// Close the socket when finished receiving datagrams
wprintf(L"Finished receiving. Closing socket.\n");
iResult = closesocket(RecvSocket);
if (iResult == SOCKET_ERROR) {
wprintf(L"closesocket failed with error %d\n", WSAGetLastError());
return 1;
}
//-----------------------------------------------
// Clean up and exit.
wprintf(L"Exiting.\n");
WSACleanup();
return 0;
}
Windows Phone 8: この関数は、Windows Phone 8 以降の Windows Phone ストアアプリでサポートされています。
Windows 8.1 および Windows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされています。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// WS2_32.dll
#include <windows.h>
INT recvfrom(
SOCKET s,
LPSTR buf,
INT len,
INT flags,
SOCKADDR* from, // optional
INT* fromlen // optional
);[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int recvfrom(
UIntPtr s, // SOCKET
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder buf, // LPSTR out
int len, // INT
int flags, // INT
IntPtr from, // SOCKADDR* optional, out
IntPtr fromlen // INT* optional, in/out
);<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function recvfrom(
s As UIntPtr, ' SOCKET
<MarshalAs(UnmanagedType.LPStr)> buf As System.Text.StringBuilder, ' LPSTR out
len As Integer, ' INT
flags As Integer, ' INT
[from] As IntPtr, ' SOCKADDR* optional, out
fromlen As IntPtr ' INT* optional, in/out
) As Integer
End Function' s : SOCKET
' buf : LPSTR out
' len : INT
' flags : INT
' from : SOCKADDR* optional, out
' fromlen : INT* optional, in/out
Declare PtrSafe Function recvfrom Lib "ws2_32" ( _
ByVal s As LongPtr, _
ByVal buf As String, _
ByVal len As Long, _
ByVal flags As Long, _
ByVal from As LongPtr, _
ByVal fromlen As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
recvfrom = ctypes.windll.ws2_32.recvfrom
recvfrom.restype = ctypes.c_int
recvfrom.argtypes = [
ctypes.c_size_t, # s : SOCKET
wintypes.LPSTR, # buf : LPSTR out
ctypes.c_int, # len : INT
ctypes.c_int, # flags : INT
ctypes.c_void_p, # from : SOCKADDR* optional, out
ctypes.POINTER(ctypes.c_int), # fromlen : INT* optional, in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WS2_32.dll')
recvfrom = Fiddle::Function.new(
lib['recvfrom'],
[
Fiddle::TYPE_UINTPTR_T, # s : SOCKET
Fiddle::TYPE_VOIDP, # buf : LPSTR out
Fiddle::TYPE_INT, # len : INT
Fiddle::TYPE_INT, # flags : INT
Fiddle::TYPE_VOIDP, # from : SOCKADDR* optional, out
Fiddle::TYPE_VOIDP, # fromlen : INT* optional, in/out
],
Fiddle::TYPE_INT)#[link(name = "ws2_32")]
extern "system" {
fn recvfrom(
s: usize, // SOCKET
buf: *mut u8, // LPSTR out
len: i32, // INT
flags: i32, // INT
from: *mut SOCKADDR, // SOCKADDR* optional, out
fromlen: *mut i32 // INT* optional, in/out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int recvfrom(UIntPtr s, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder buf, int len, int flags, IntPtr from, IntPtr fromlen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_recvfrom' -Namespace Win32 -PassThru
# $api::recvfrom(s, buf, len, flags, from, fromlen)#uselib "WS2_32.dll"
#func global recvfrom "recvfrom" sptr, sptr, sptr, sptr, sptr, sptr
; recvfrom s, varptr(buf), len, flags, varptr(from), varptr(fromlen) ; 戻り値は stat
; s : SOCKET -> "sptr"
; buf : LPSTR out -> "sptr"
; len : INT -> "sptr"
; flags : INT -> "sptr"
; from : SOCKADDR* optional, out -> "sptr"
; fromlen : INT* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WS2_32.dll" #cfunc global recvfrom "recvfrom" sptr, var, int, int, var, var ; res = recvfrom(s, buf, len, flags, from, fromlen) ; s : SOCKET -> "sptr" ; buf : LPSTR out -> "var" ; len : INT -> "int" ; flags : INT -> "int" ; from : SOCKADDR* optional, out -> "var" ; fromlen : INT* optional, in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll" #cfunc global recvfrom "recvfrom" sptr, sptr, int, int, sptr, sptr ; res = recvfrom(s, varptr(buf), len, flags, varptr(from), varptr(fromlen)) ; s : SOCKET -> "sptr" ; buf : LPSTR out -> "sptr" ; len : INT -> "int" ; flags : INT -> "int" ; from : SOCKADDR* optional, out -> "sptr" ; fromlen : INT* optional, in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; INT recvfrom(SOCKET s, LPSTR buf, INT len, INT flags, SOCKADDR* from, INT* fromlen) #uselib "WS2_32.dll" #cfunc global recvfrom "recvfrom" intptr, var, int, int, var, var ; res = recvfrom(s, buf, len, flags, from, fromlen) ; s : SOCKET -> "intptr" ; buf : LPSTR out -> "var" ; len : INT -> "int" ; flags : INT -> "int" ; from : SOCKADDR* optional, out -> "var" ; fromlen : INT* optional, in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; INT recvfrom(SOCKET s, LPSTR buf, INT len, INT flags, SOCKADDR* from, INT* fromlen) #uselib "WS2_32.dll" #cfunc global recvfrom "recvfrom" intptr, intptr, int, int, intptr, intptr ; res = recvfrom(s, varptr(buf), len, flags, varptr(from), varptr(fromlen)) ; s : SOCKET -> "intptr" ; buf : LPSTR out -> "intptr" ; len : INT -> "int" ; flags : INT -> "int" ; from : SOCKADDR* optional, out -> "intptr" ; fromlen : INT* optional, in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
procrecvfrom = ws2_32.NewProc("recvfrom")
)
// s (SOCKET), buf (LPSTR out), len (INT), flags (INT), from (SOCKADDR* optional, out), fromlen (INT* optional, in/out)
r1, _, err := procrecvfrom.Call(
uintptr(s),
uintptr(buf),
uintptr(len),
uintptr(flags),
uintptr(from),
uintptr(fromlen),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction recvfrom(
s: NativeUInt; // SOCKET
buf: PAnsiChar; // LPSTR out
len: Integer; // INT
flags: Integer; // INT
from: Pointer; // SOCKADDR* optional, out
fromlen: Pointer // INT* optional, in/out
): Integer; stdcall;
external 'WS2_32.dll' name 'recvfrom';result := DllCall("WS2_32\recvfrom"
, "UPtr", s ; SOCKET
, "Ptr", buf ; LPSTR out
, "Int", len ; INT
, "Int", flags ; INT
, "Ptr", from ; SOCKADDR* optional, out
, "Ptr", fromlen ; INT* optional, in/out
, "Int") ; return: INT●recvfrom(s, buf, len, flags, from, fromlen) = DLL("WS2_32.dll", "int recvfrom(int, char*, int, int, void*, void*)")
# 呼び出し: recvfrom(s, buf, len, flags, from, fromlen)
# s : SOCKET -> "int"
# buf : LPSTR out -> "char*"
# len : INT -> "int"
# flags : INT -> "int"
# from : SOCKADDR* optional, out -> "void*"
# fromlen : INT* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "ws2_32" fn recvfrom(
s: usize, // SOCKET
buf: [*c]u8, // LPSTR out
len: i32, // INT
flags: i32, // INT
from: [*c]SOCKADDR, // SOCKADDR* optional, out
fromlen: [*c]i32 // INT* optional, in/out
) callconv(std.os.windows.WINAPI) i32;proc recvfrom(
s: uint, # SOCKET
buf: ptr char, # LPSTR out
len: int32, # INT
flags: int32, # INT
`from`: ptr SOCKADDR, # SOCKADDR* optional, out
fromlen: ptr int32 # INT* optional, in/out
): int32 {.importc: "recvfrom", stdcall, dynlib: "WS2_32.dll".}pragma(lib, "ws2_32");
extern(Windows)
int recvfrom(
size_t s, // SOCKET
char* buf, // LPSTR out
int len, // INT
int flags, // INT
SOCKADDR* from, // SOCKADDR* optional, out
int* fromlen // INT* optional, in/out
);ccall((:recvfrom, "WS2_32.dll"), stdcall, Int32,
(Csize_t, Ptr{UInt8}, Int32, Int32, Ptr{SOCKADDR}, Ptr{Int32}),
s, buf, len, flags, from, fromlen)
# s : SOCKET -> Csize_t
# buf : LPSTR out -> Ptr{UInt8}
# len : INT -> Int32
# flags : INT -> Int32
# from : SOCKADDR* optional, out -> Ptr{SOCKADDR}
# fromlen : INT* optional, in/out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t recvfrom(
uintptr_t s,
char* buf,
int32_t len,
int32_t flags,
void* from,
int32_t* fromlen);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.recvfrom(s, buf, len, flags, from, fromlen)
-- s : SOCKET
-- buf : LPSTR out
-- len : INT
-- flags : INT
-- from : SOCKADDR* optional, out
-- fromlen : INT* optional, in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const recvfrom = lib.func('__stdcall', 'recvfrom', 'int32_t', ['uintptr_t', 'char *', 'int32_t', 'int32_t', 'void *', 'int32_t *']);
// recvfrom(s, buf, len, flags, from, fromlen)
// s : SOCKET -> 'uintptr_t'
// buf : LPSTR out -> 'char *'
// len : INT -> 'int32_t'
// flags : INT -> 'int32_t'
// from : SOCKADDR* optional, out -> 'void *'
// fromlen : INT* optional, in/out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WS2_32.dll", {
recvfrom: { parameters: ["usize", "buffer", "i32", "i32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.recvfrom(s, buf, len, flags, from, fromlen)
// s : SOCKET -> "usize"
// buf : LPSTR out -> "buffer"
// len : INT -> "i32"
// flags : INT -> "i32"
// from : SOCKADDR* optional, out -> "pointer"
// fromlen : INT* optional, in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t recvfrom(
size_t s,
char* buf,
int32_t len,
int32_t flags,
void* from,
int32_t* fromlen);
C, "WS2_32.dll");
// $ffi->recvfrom(s, buf, len, flags, from, fromlen);
// s : SOCKET
// buf : LPSTR out
// len : INT
// flags : INT
// from : SOCKADDR* optional, out
// fromlen : INT* optional, 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 Ws2_32 extends StdCallLibrary {
Ws2_32 INSTANCE = Native.load("ws2_32", Ws2_32.class);
int recvfrom(
long s, // SOCKET
byte[] buf, // LPSTR out
int len, // INT
int flags, // INT
Pointer from, // SOCKADDR* optional, out
IntByReference fromlen // INT* optional, in/out
);
}@[Link("ws2_32")]
lib LibWS2_32
fun recvfrom = recvfrom(
s : LibC::SizeT, # SOCKET
buf : UInt8*, # LPSTR out
len : Int32, # INT
flags : Int32, # INT
from : SOCKADDR*, # SOCKADDR* optional, out
fromlen : Int32* # INT* optional, 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 recvfromNative = Int32 Function(UintPtr, Pointer<Utf8>, Int32, Int32, Pointer<Void>, Pointer<Int32>);
typedef recvfromDart = int Function(int, Pointer<Utf8>, int, int, Pointer<Void>, Pointer<Int32>);
final recvfrom = DynamicLibrary.open('WS2_32.dll')
.lookupFunction<recvfromNative, recvfromDart>('recvfrom');
// s : SOCKET -> UintPtr
// buf : LPSTR out -> Pointer<Utf8>
// len : INT -> Int32
// flags : INT -> Int32
// from : SOCKADDR* optional, out -> Pointer<Void>
// fromlen : INT* optional, in/out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function recvfrom(
s: NativeUInt; // SOCKET
buf: PAnsiChar; // LPSTR out
len: Integer; // INT
flags: Integer; // INT
from: Pointer; // SOCKADDR* optional, out
fromlen: Pointer // INT* optional, in/out
): Integer; stdcall;
external 'WS2_32.dll' name 'recvfrom';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "recvfrom"
c_recvfrom :: CUIntPtr -> CString -> Int32 -> Int32 -> Ptr () -> Ptr Int32 -> IO Int32
-- s : SOCKET -> CUIntPtr
-- buf : LPSTR out -> CString
-- len : INT -> Int32
-- flags : INT -> Int32
-- from : SOCKADDR* optional, out -> Ptr ()
-- fromlen : INT* optional, in/out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let recvfrom =
foreign "recvfrom"
(size_t @-> string @-> int32_t @-> int32_t @-> (ptr void) @-> (ptr int32_t) @-> returning int32_t)
(* s : SOCKET -> size_t *)
(* buf : LPSTR out -> string *)
(* len : INT -> int32_t *)
(* flags : INT -> int32_t *)
(* from : SOCKADDR* optional, out -> (ptr void) *)
(* fromlen : INT* optional, in/out -> (ptr int32_t) *)
(* 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 ("recvfrom" recvfrom :convention :stdcall) :int32
(s :uint64) ; SOCKET
(buf :pointer) ; LPSTR out
(len :int32) ; INT
(flags :int32) ; INT
(from :pointer) ; SOCKADDR* optional, out
(fromlen :pointer)) ; INT* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $recvfrom = Win32::API::More->new('WS2_32',
'int recvfrom(WPARAM s, LPSTR buf, int len, int flags, LPVOID from, LPVOID fromlen)');
# my $ret = $recvfrom->Call($s, $buf, $len, $flags, $from, $fromlen);
# s : SOCKET -> WPARAM
# buf : LPSTR out -> LPSTR
# len : INT -> int
# flags : INT -> int
# from : SOCKADDR* optional, out -> LPVOID
# fromlen : INT* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f WSAAsyncSelect — ソケットのネットワークイベント通知をウィンドウメッセージで要求する。
- f WSAEventSelect — ソケットのネットワークイベントをイベントオブジェクトに関連付ける。
- f recv — 接続ソケットからデータを受信する。
- f send — 接続ソケットへデータを送信する。
- f socket — 指定したアドレスファミリ・型・プロトコルのソケットを作成する。