WSAEventSelect
関数シグネチャ
// WS2_32.dll
#include <windows.h>
INT WSAEventSelect(
SOCKET s,
WSAEVENT hEventObject, // optional
INT lNetworkEvents
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| s | SOCKET | in | ソケットを識別するディスクリプタです。 |
| hEventObject | WSAEVENT | inoptional | 指定した一連の FD_XXX ネットワークイベントに関連付けるイベントオブジェクトを識別するハンドルです。 |
| lNetworkEvents | INT | in | アプリケーションが関心を持つ FD_XXX ネットワークイベントの組み合わせを指定するビットマスクです。 |
戻り値の型: INT
公式ドキュメント
WSAEventSelect 関数は、指定した一連の FD_XXX ネットワークイベントに関連付けるイベントオブジェクトを指定します。
戻り値
アプリケーションによるネットワークイベントと関連付けるイベントオブジェクトの指定が成功した場合、戻り値は 0 です。それ以外の場合は SOCKET_ERROR が返され、 WSAGetLastError を呼び出すことで具体的なエラー番号を取得できます。
select や WSAAsyncSelect 関数の場合と同様に、 WSAEventSelect は、データ転送操作(send または recv)を即座に成功する見込みで発行できるタイミングを判断するためによく使用されます。ただし、堅牢なアプリケーションは、イベントオブジェクトがセットされた状態で Windows Sockets の呼び出しを発行したにもかかわらず、即座に WSAEWOULDBLOCK が返される可能性に備えておく必要があります。たとえば、次のような操作シーケンスが起こり得ます。
- ソケット s にデータが到着し、Windows Sockets が WSAEventSelect のイベントオブジェクトをセットする。
- アプリケーションが他の処理を行う。
- 処理中に、アプリケーションが ioctlsocket(s, FIONREAD...) を発行し、読み取り可能なデータがあることに気づく。
- アプリケーションが recv(s,...) を発行してデータを読み取る。
- アプリケーションが最終的に WSAEventSelect で指定したイベントオブジェクトを待機し、データが読み取り可能であることを示してすぐに復帰する。
- アプリケーションが recv(s,...) を発行するが、エラー WSAEWOULDBLOCK で失敗する。
| ネットワークイベント | 再有効化する関数 |
|---|---|
| recv、 recvfrom、 WSARecv、WSARecvEx、または WSARecvFrom 関数。 | |
| send、 sendto、 WSASend、または WSASendTo 関数。 | |
| recv、 recvfrom、 WSARecv、WSARecvEx、または WSARecvFrom 関数。 | |
| accept、AcceptEx、または WSAAccept 関数。ただし、返されたエラーコードが、条件関数が CF_DEFER を返したことを示す WSATRY_AGAIN である場合を除きます。 | |
| なし。 | |
| なし。 | |
|
コマンド SIO_GET_QOS を指定した WSAIoctl 関数。 |
|
予約済み。 |
|
コマンド SIO_ROUTING_INTERFACE_CHANGE を指定した WSAIoctl 関数。 |
|
コマンド SIO_ADDRESS_LIST_CHANGE を指定した WSAIoctl 関数。 |
再有効化ルーチンへの呼び出しは、たとえ失敗した呼び出しであっても、該当するネットワークイベントおよびイベントオブジェクトに対する記録とシグナル化が再有効化されます。
FD_READ、FD_OOB、FD_ACCEPT の各ネットワークイベントでは、ネットワークイベントの記録およびイベントオブジェクトのシグナル化はレベルトリガーです。これは、再有効化ルーチンが呼び出され、その呼び出し後も該当するネットワーク条件が依然として有効である場合、ネットワークイベントが記録され、関連付けられたイベントオブジェクトがセットされることを意味します。これにより、アプリケーションは一度に到着するデータ量を気にすることなく、イベント駆動型にできます。次のシーケンスを考えてみてください。
- トランスポートプロバイダーがソケット s 上で 100 バイトのデータを受信し、WS2_32.DLL に FD_READ ネットワークイベントを記録させ、関連付けられたイベントオブジェクトをセットさせる。
- アプリケーションが recv(s, buffptr, 50, 0) を発行して 50 バイトを読み取る。
- 読み取るべきデータがまだ残っているため、トランスポートプロバイダーが WS2_32.DLL に FD_READ ネットワークイベントを再び記録させ、関連付けられたイベントオブジェクトをセットさせる。
FD_QOS イベントはエッジトリガーとみなされます。サービス品質の変更が発生したときに、メッセージはちょうど 1 回だけ送出されます。それ以降のメッセージは、プロバイダーがサービス品質のさらなる変更を検出するか、アプリケーションがソケットのサービス品質を再ネゴシエーションするまで送出されません。
FD_ROUTING_INTERFACE_CHANGE および FD_ADDRESS_LIST_CHANGE イベントも同様にエッジトリガーとみなされます。アプリケーションが SIO_ROUTING_INTERFACE_CHANGE または SIO_ADDRESS_LIST_CHANGE を指定して WSAIoctl を発行して通知を要求した後に変更が発生したとき、メッセージはちょうど 1 回だけ送出されます。それ以降のメッセージは、アプリケーションが IOCTL を再発行し、その IOCTL の発行以降に別の変更が検出されるまで送出されません。
アプリケーションが WSAEventSelect を呼び出した時点、または再有効化関数が呼び出された時点で、ネットワークイベントがすでに発生している場合は、ネットワークイベントが記録され、必要に応じて関連付けられたイベントオブジェクトがセットされます。たとえば、次のシーケンスを考えてみてください。
- アプリケーションが listen を呼び出す。
- 接続要求を受信したが、まだ受理していない。
- アプリケーションが、当該ソケットの FD_ACCEPT ネットワークイベントに関心があることを指定して WSAEventSelect を呼び出す。ネットワークイベントの永続性により、Windows Sockets は FD_ACCEPT ネットワークイベントを記録し、関連付けられたイベントオブジェクトを直ちにセットする。
FD_OOB ネットワークイベントは、ソケットが OOB データを別個に受信するように構成されている場合にのみ使用されます。ソケットが OOB データをインラインで受信するように構成されている場合、OOB(緊急)データは通常のデータとして扱われ、アプリケーションは FD_OOB ネットワークイベントではなく FD_READ ネットワークイベントに関心を登録し、FD_READ ネットワークイベントを受け取ります。アプリケーションは、SO_OOBINLINE オプションに対して setsockopt または getsockopt を使用して、OOB データの処理方法を設定または確認できます。
FD_CLOSE ネットワークイベントのエラーコードは、ソケットのクローズが正常(graceful)であったか異常(abortive)であったかを示します。エラーコードが 0 の場合はクローズが正常に行われたことを意味し、エラーコードが WSAECONNRESET の場合はソケットの仮想回線がリセットされたことを意味します。これは SOCK_STREAM などのコネクション指向ソケットにのみ適用されます。
FD_CLOSE ネットワークイベントは、ソケットに対応する仮想回線に対してクローズ通知を受信したときに記録されます。TCP の用語では、これは接続が TIME WAIT または CLOSE WAIT 状態に入ったときに FD_CLOSE が記録されることを意味します。これは、リモート側が送信側で shutdown を実行するか、 closesocket を実行した結果として発生します。FD_CLOSE は、ソケットからすべてのデータが読み取られた後に送出されます。データを失う可能性を避けるため、アプリケーションは FD_CLOSE の受信時に残りのデータがないか確認する必要があります。詳細については、Graceful Shutdown, Linger Options, and Socket Closure のセクションおよび shutdown 関数を参照してください。
Windows Sockets は仮想回線のクローズを示すために FD_CLOSE ネットワークイベントのみを記録することに注意してください。この状況を示すために FD_READ ネットワークイベントを記録することはありません。
FD_QOS または FD_GROUP_QOS ネットワークイベントは、ソケット s に関連付けられたフロー仕様内の任意のパラメーターが変化したときに記録されます。アプリケーションは、ソケット s の現在のサービス品質を取得するために、コマンド SIO_GET_QOS を指定して WSAIoctl を使用する必要があります。
FD_ROUTING_INTERFACE_CHANGE ネットワークイベントは、SIO_ROUTING_INTERFACE_CHANGE を指定した WSAIoctl で指定された宛先に到達するために使用すべきローカルインターフェイスが、その IOCTL の発行後に変化したときに記録されます。
FD_ADDRESS_LIST_CHANGE ネットワークイベントは、SIO_ADDRESS_LIST_CHANGE を指定した WSAIoctl の発行後に、アプリケーションがバインドできるソケットのプロトコルファミリのアドレスのリストが変化したときに記録されます。
| エラーコード | 意味 |
|---|---|
| WSANOTINITIALISED | この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。 |
| WSAENETDOWN | ネットワークサブシステムが失敗しました。 |
| WSAEINVAL | 指定されたパラメーターの 1 つが無効であるか、指定されたソケットが無効な状態です。 |
| WSAEINPROGRESS | ブロッキングする Windows Sockets 1.1 の呼び出しが進行中であるか、サービスプロバイダーがコールバック関数をまだ処理中です。 |
| WSAENOTSOCK | ディスクリプタがソケットではありません。 |
解説(Remarks)
WSAEventSelect 関数は、選択した FD_XXX ネットワークイベント lNetworkEvents に関連付けるイベントオブジェクト hEventObject を指定するために使用します。イベントオブジェクトを指定する対象のソケットは、s パラメーターで識別されます。指定したネットワークイベントのいずれかが発生すると、イベントオブジェクトがセットされます。
WSAEventSelect 関数は WSAAsyncSelect と非常によく似た動作をしますが、指定したネットワークイベントが発生したときに行われる動作が異なります。 WSAAsyncSelect 関数は、アプリケーションが指定した Windows メッセージを送出させます。 WSAEventSelect は、関連付けられたイベントオブジェクトをセットし、このイベントの発生を内部のネットワークイベントレコードに記録します。アプリケーションは WSAWaitForMultipleEvents を使用してイベントオブジェクトを待機またはポーリングし、 WSAEnumNetworkEvents を使用して内部のネットワークイベントレコードの内容を取得し、指定したネットワークイベントのうちどれが発生したかを判断できます。
WSAEventSelect 関数で使用したイベントオブジェクトの状態をリセットする正しい方法は、そのイベントオブジェクトのハンドルを WSAEnumNetworkEvents 関数の hEventObject パラメーターに渡すことです。これにより、イベントオブジェクトがリセットされ、ソケット上のアクティブな FD イベントの状態がアトミックに調整されます。
WSAEventSelect は、ネットワークアクティビティとエラーを記録し、 WSAEnumNetworkEvents を通じて取得可能にする唯一の関数です。これらの関数がネットワークアクティビティとエラーをどのように報告するかについては、 select および WSAAsyncSelect の説明を参照してください。
WSAEventSelect 関数は、lNetworkEvents の値にかかわらず、ソケット s を自動的に非ブロッキングモードに設定します。ソケット s をブロッキングモードに戻すには、まず lNetworkEvents を 0 に、hEventObject パラメーターを NULL に設定して WSAEventSelect を呼び出すことで、ソケット s に関連付けられたイベントレコードをクリアする必要があります。その後、ioctlsocket または WSAIoctl を呼び出して、ソケットをブロッキングモードに戻すことができます。
lNetworkEvents パラメーターは、次のリストに示す値のいずれかをビット単位の OR 演算子で組み合わせて構築します。
| 値 | 意味 |
|---|---|
| FD_READ | 読み取り準備完了の通知を受け取ることを希望します。 |
| FD_WRITE | 書き込み準備完了の通知を受け取ることを希望します。 |
| FD_OOB | OOB データの到着の通知を受け取ることを希望します。 |
| FD_ACCEPT | 着信接続の通知を受け取ることを希望します。 |
| FD_CONNECT | 接続またはマルチポイント参加操作の完了の通知を受け取ることを希望します。 |
| FD_CLOSE | ソケットのクローズの通知を受け取ることを希望します。 |
| FD_QOS | ソケットの QoS 変更の通知を受け取ることを希望します。 |
| FD_GROUP_QOS | ソケットグループでの将来の使用のために予約されています。ソケットグループの QoS 変更の通知を受け取ることを希望します。 |
| FD_ROUTING_ INTERFACE_CHANGE | 指定した宛先に対するルーティングインターフェイスの変更の通知を受け取ることを希望します。 |
| FD_ADDRESS_ LIST_CHANGE | ソケットのアドレスファミリに対するローカルアドレスリストの変更の通知を受け取ることを希望します。 |
あるソケットに対して WSAEventSelect を発行すると、同じソケットに対する以前の WSAAsyncSelect または WSAEventSelect がキャンセルされ、内部のネットワークイベントレコードがクリアされます。たとえば、イベントオブジェクトを読み取りと書き込みの両方のネットワークイベントに関連付けるには、アプリケーションは次のように FD_READ と FD_WRITE の両方を指定して WSAEventSelect を呼び出す必要があります。
rc = WSAEventSelect(s, hEventObject, FD_READ|FD_WRITE);
異なるネットワークイベントに対して異なるイベントオブジェクトを指定することはできません。次のコードは機能しません。2 回目の呼び出しが 1 回目の効果をキャンセルし、FD_WRITE ネットワークイベントのみが hEventObject2 に関連付けられます。
rc = WSAEventSelect(s, hEventObject1, FD_READ);
rc = WSAEventSelect(s, hEventObject2, FD_WRITE); //bad
ソケット上のネットワークイベントの関連付けと選択をキャンセルするには、lNetworkEvents を 0 に設定する必要があります。この場合、hEventObject パラメーターは無視されます。
rc = WSAEventSelect(s, hEventObject, 0);
closesocket でソケットをクローズすると、そのソケットに対して WSAEventSelect で指定したネットワークイベントの関連付けと選択もキャンセルされます。ただし、アプリケーションは依然として WSACloseEvent を呼び出してイベントオブジェクトを明示的にクローズし、すべてのリソースを解放する必要があります。
accept 関数を呼び出したときに作成されるソケットは、それを受理するために使用したリスニングソケットと同じプロパティを持ちます。リスニングソケットに対して設定された WSAEventSelect の関連付けおよびネットワークイベントの選択は、受理されたソケットに適用されます。たとえば、リスニングソケットが hEventObject を FD_ACCEPT、FD_READ、FD_WRITE に関連付ける WSAEventSelect の関連付けを持つ場合、そのリスニングソケットで受理された任意のソケットも、同じ hEventObject に関連付けられた FD_ACCEPT、FD_READ、FD_WRITE ネットワークイベントを持ちます。異なる hEventObject またはネットワークイベントが必要な場合、アプリケーションは受理されたソケットと希望する新しい情報を渡して WSAEventSelect を呼び出す必要があります。
サンプルコード
次の例は、WSAEventSelect 関数の使用方法を示しています。//-------------------------
// Declare and initialize variables
SOCKET ListenSocket;
WSAEVENT NewEvent;
sockaddr_in InetAddr;
//-------------------------
// Initialize listening socket
ListenSocket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
//-------------------------
// Bind listening socket
InetAddr.sin_family = AF_INET;
InetAddr.sin_addr.s_addr = htonl(INADDR_ANY);
InetAddr.sin_port = htons(27015);
bind (ListenSocket, (SOCKADDR *) &InetAddr, sizeof(InetAddr));
//-------------------------
// Create new event
NewEvent = WSACreateEvent();
//-------------------------
// Associate event types FD_ACCEPT and FD_CLOSE
// with the listening socket and NewEvent
WSAEventSelect( ListenSocket, NewEvent, FD_ACCEPT | FD_CLOSE);
//----------------------
// Listen for incoming connection requests
// on the created socket
if (listen( ListenSocket, SOMAXCONN ) == SOCKET_ERROR)
printf("Error listening on socket.\n");
printf("Listening on socket...\n");
// Need an event handler added to handle connection requests
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 WSAEventSelect(
SOCKET s,
WSAEVENT hEventObject, // optional
INT lNetworkEvents
);[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSAEventSelect(
UIntPtr s, // SOCKET
IntPtr hEventObject, // WSAEVENT optional
int lNetworkEvents // INT
);<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAEventSelect(
s As UIntPtr, ' SOCKET
hEventObject As IntPtr, ' WSAEVENT optional
lNetworkEvents As Integer ' INT
) As Integer
End Function' s : SOCKET
' hEventObject : WSAEVENT optional
' lNetworkEvents : INT
Declare PtrSafe Function WSAEventSelect Lib "ws2_32" ( _
ByVal s As LongPtr, _
ByVal hEventObject As LongPtr, _
ByVal lNetworkEvents As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
WSAEventSelect = ctypes.windll.ws2_32.WSAEventSelect
WSAEventSelect.restype = ctypes.c_int
WSAEventSelect.argtypes = [
ctypes.c_size_t, # s : SOCKET
ctypes.c_ssize_t, # hEventObject : WSAEVENT optional
ctypes.c_int, # lNetworkEvents : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WS2_32.dll')
WSAEventSelect = Fiddle::Function.new(
lib['WSAEventSelect'],
[
Fiddle::TYPE_UINTPTR_T, # s : SOCKET
Fiddle::TYPE_INTPTR_T, # hEventObject : WSAEVENT optional
Fiddle::TYPE_INT, # lNetworkEvents : INT
],
Fiddle::TYPE_INT)#[link(name = "ws2_32")]
extern "system" {
fn WSAEventSelect(
s: usize, // SOCKET
hEventObject: isize, // WSAEVENT optional
lNetworkEvents: i32 // INT
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int WSAEventSelect(UIntPtr s, IntPtr hEventObject, int lNetworkEvents);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAEventSelect' -Namespace Win32 -PassThru
# $api::WSAEventSelect(s, hEventObject, lNetworkEvents)#uselib "WS2_32.dll"
#func global WSAEventSelect "WSAEventSelect" sptr, sptr, sptr
; WSAEventSelect s, hEventObject, lNetworkEvents ; 戻り値は stat
; s : SOCKET -> "sptr"
; hEventObject : WSAEVENT optional -> "sptr"
; lNetworkEvents : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WS2_32.dll"
#cfunc global WSAEventSelect "WSAEventSelect" sptr, sptr, int
; res = WSAEventSelect(s, hEventObject, lNetworkEvents)
; s : SOCKET -> "sptr"
; hEventObject : WSAEVENT optional -> "sptr"
; lNetworkEvents : INT -> "int"; INT WSAEventSelect(SOCKET s, WSAEVENT hEventObject, INT lNetworkEvents)
#uselib "WS2_32.dll"
#cfunc global WSAEventSelect "WSAEventSelect" intptr, intptr, int
; res = WSAEventSelect(s, hEventObject, lNetworkEvents)
; s : SOCKET -> "intptr"
; hEventObject : WSAEVENT optional -> "intptr"
; lNetworkEvents : INT -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
procWSAEventSelect = ws2_32.NewProc("WSAEventSelect")
)
// s (SOCKET), hEventObject (WSAEVENT optional), lNetworkEvents (INT)
r1, _, err := procWSAEventSelect.Call(
uintptr(s),
uintptr(hEventObject),
uintptr(lNetworkEvents),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction WSAEventSelect(
s: NativeUInt; // SOCKET
hEventObject: NativeInt; // WSAEVENT optional
lNetworkEvents: Integer // INT
): Integer; stdcall;
external 'WS2_32.dll' name 'WSAEventSelect';result := DllCall("WS2_32\WSAEventSelect"
, "UPtr", s ; SOCKET
, "Ptr", hEventObject ; WSAEVENT optional
, "Int", lNetworkEvents ; INT
, "Int") ; return: INT●WSAEventSelect(s, hEventObject, lNetworkEvents) = DLL("WS2_32.dll", "int WSAEventSelect(int, int, int)")
# 呼び出し: WSAEventSelect(s, hEventObject, lNetworkEvents)
# s : SOCKET -> "int"
# hEventObject : WSAEVENT optional -> "int"
# lNetworkEvents : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "ws2_32" fn WSAEventSelect(
s: usize, // SOCKET
hEventObject: isize, // WSAEVENT optional
lNetworkEvents: i32 // INT
) callconv(std.os.windows.WINAPI) i32;proc WSAEventSelect(
s: uint, # SOCKET
hEventObject: int, # WSAEVENT optional
lNetworkEvents: int32 # INT
): int32 {.importc: "WSAEventSelect", stdcall, dynlib: "WS2_32.dll".}pragma(lib, "ws2_32");
extern(Windows)
int WSAEventSelect(
size_t s, // SOCKET
ptrdiff_t hEventObject, // WSAEVENT optional
int lNetworkEvents // INT
);ccall((:WSAEventSelect, "WS2_32.dll"), stdcall, Int32,
(Csize_t, Int, Int32),
s, hEventObject, lNetworkEvents)
# s : SOCKET -> Csize_t
# hEventObject : WSAEVENT optional -> Int
# lNetworkEvents : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t WSAEventSelect(
uintptr_t s,
intptr_t hEventObject,
int32_t lNetworkEvents);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.WSAEventSelect(s, hEventObject, lNetworkEvents)
-- s : SOCKET
-- hEventObject : WSAEVENT optional
-- lNetworkEvents : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const WSAEventSelect = lib.func('__stdcall', 'WSAEventSelect', 'int32_t', ['uintptr_t', 'intptr_t', 'int32_t']);
// WSAEventSelect(s, hEventObject, lNetworkEvents)
// s : SOCKET -> 'uintptr_t'
// hEventObject : WSAEVENT optional -> 'intptr_t'
// lNetworkEvents : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WS2_32.dll", {
WSAEventSelect: { parameters: ["usize", "isize", "i32"], result: "i32" },
});
// lib.symbols.WSAEventSelect(s, hEventObject, lNetworkEvents)
// s : SOCKET -> "usize"
// hEventObject : WSAEVENT optional -> "isize"
// lNetworkEvents : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t WSAEventSelect(
size_t s,
intptr_t hEventObject,
int32_t lNetworkEvents);
C, "WS2_32.dll");
// $ffi->WSAEventSelect(s, hEventObject, lNetworkEvents);
// s : SOCKET
// hEventObject : WSAEVENT optional
// lNetworkEvents : INT
// 構造体/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 WSAEventSelect(
long s, // SOCKET
long hEventObject, // WSAEVENT optional
int lNetworkEvents // INT
);
}@[Link("ws2_32")]
lib LibWS2_32
fun WSAEventSelect = WSAEventSelect(
s : LibC::SizeT, # SOCKET
hEventObject : LibC::SSizeT, # WSAEVENT optional
lNetworkEvents : Int32 # INT
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef WSAEventSelectNative = Int32 Function(UintPtr, IntPtr, Int32);
typedef WSAEventSelectDart = int Function(int, int, int);
final WSAEventSelect = DynamicLibrary.open('WS2_32.dll')
.lookupFunction<WSAEventSelectNative, WSAEventSelectDart>('WSAEventSelect');
// s : SOCKET -> UintPtr
// hEventObject : WSAEVENT optional -> IntPtr
// lNetworkEvents : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WSAEventSelect(
s: NativeUInt; // SOCKET
hEventObject: NativeInt; // WSAEVENT optional
lNetworkEvents: Integer // INT
): Integer; stdcall;
external 'WS2_32.dll' name 'WSAEventSelect';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WSAEventSelect"
c_WSAEventSelect :: CUIntPtr -> CIntPtr -> Int32 -> IO Int32
-- s : SOCKET -> CUIntPtr
-- hEventObject : WSAEVENT optional -> CIntPtr
-- lNetworkEvents : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let wsaeventselect =
foreign "WSAEventSelect"
(size_t @-> intptr_t @-> int32_t @-> returning int32_t)
(* s : SOCKET -> size_t *)
(* hEventObject : WSAEVENT optional -> intptr_t *)
(* lNetworkEvents : INT -> 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 ("WSAEventSelect" wsaevent-select :convention :stdcall) :int32
(s :uint64) ; SOCKET
(h-event-object :int64) ; WSAEVENT optional
(l-network-events :int32)) ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WSAEventSelect = Win32::API::More->new('WS2_32',
'int WSAEventSelect(WPARAM s, LPARAM hEventObject, int lNetworkEvents)');
# my $ret = $WSAEventSelect->Call($s, $hEventObject, $lNetworkEvents);
# s : SOCKET -> WPARAM
# hEventObject : WSAEVENT optional -> LPARAM
# lNetworkEvents : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f WSAAsyncSelect — ソケットのネットワークイベント通知をウィンドウメッセージで要求する。
- f WSACloseEvent — イベントオブジェクトハンドルを閉じて解放する。
- f WSACreateEvent — 新しいイベントオブジェクトを作成する。
- f WSAEnumNetworkEvents — ソケットで発生したネットワークイベントを列挙取得する。
- f WSAWaitForMultipleEvents — 複数のイベントオブジェクトがシグナルになるまで待機する。
- f shutdown — ソケットの送受信を部分的または全面的に停止する。