ホーム › Networking.WinSock › RIO_NOTIFICATION_COMPLETION

RIO_NOTIFICATION_COMPLETION

構造体

サイズx64: 16 バイト / x86: 8 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド	型	サイズ	x64	x86	説明
Type	RIO_NOTIFICATION_COMPLETION_TYPE	4	+0	+0	データを送受信する際に RIONotify 関数で使用する完了の種類です。
Anonymous	_Anonymous_e__Union	8/4	+8	+4	イベントハンドルまたはIOCP情報を保持する共用体。

共用体: _Anonymous_e__Union x64 8B / x86 4B

フィールド	型	サイズ	x64	x86
Event	_Event_e__Struct	8/4	+0	+0
Iocp	_Iocp_e__Struct	8/4	+0	+0

公式ドキュメント

RIO_NOTIFICATION_COMPLETION 構造体は、Winsock 登録済み I/O 拡張機能でネットワークデータを送受信する際に、RIONotify 関数で使用する I/O 完了の方法を指定します。

解説(Remarks)

RIO_NOTIFICATION_COMPLETION 構造体は、Winsock 登録済み I/O 拡張機能で使用する RIONotify 関数の動作を指定するために使用します。

RIO_NOTIFICATION_COMPLETION 構造体は、RIO_CQ を作成するときに RIOCreateCompletionQueue 関数に渡します。アプリケーションが完了キューに対して RIONotify 関数を呼び出さない場合は、RIO_NOTIFICATION_COMPLETION オブジェクトなしで完了キューを作成できます。

イベントを使用する完了キューの場合、RIO_NOTIFICATION_COMPLETION 構造体の Type メンバーを RIO_EVENT_COMPLETION に設定します。RIO_NOTIFICATION_COMPLETION 構造体の Event.EventHandle メンバーには、WSACreateEvent 関数または CreateEvent 関数で作成したイベントのハンドルを格納します。 RIONotify の完了を受け取るには、アプリケーションは WSAWaitForMultipleEvents または同様の待機ルーチンを使用して、指定したイベントハンドルを待機する必要があります。アプリケーションがイベントをリセットして再利用する予定の場合は、RIO_NOTIFICATION_COMPLETION 構造体の Event.NotifyReset メンバーに 0 以外の値を設定することでオーバーヘッドを削減できます。これにより、通知が発生したときに RIONotify 関数がイベントをリセットします。その結果、RIONotify 関数の呼び出しの間にイベントをリセットするために WSAResetEvent 関数を呼び出す必要がなくなります。

I/O 完了ポートを使用する完了キューの場合、RIO_NOTIFICATION_COMPLETION 構造体の Type メンバーを RIO_IOCP_COMPLETION に設定します。RIO_NOTIFICATION_COMPLETION 構造体の Iocp.IocpHandle メンバーには、CreateIoCompletionPort 関数で作成した I/O 完了ポートのハンドルを格納します。 RIONotify の完了を受け取るには、アプリケーションは GetQueuedCompletionStatus 関数または GetQueuedCompletionStatusEx 関数を呼び出す必要があります。アプリケーションは、完了キュー専用の OVERLAPPED オブジェクトを用意する必要があります。また、Iocp.CompletionKey メンバーを使用して、その完了キューに対する RIONotify 要求を、他の完了キューの RIONotify 完了を含むその他の I/O 完了と区別することもできます。

スレッドプールを使用するアプリケーションでは、スレッドプールの待機オブジェクトを使用して、スレッドプール経由で RIONotify の完了を受け取ることができます。この場合、SetThreadpoolWait 関数の呼び出しは、RIONotify の呼び出しの直後に行う必要があります。 SetThreadpoolWait 関数を RIONotify より前に呼び出し、かつアプリケーションがイベントオブジェクトのクリアを RIONotify に依存している場合、待機オブジェクトのコールバックが不必要に実行されることがあります。

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

各言語での定義

#include <windows.h>

// RIO_NOTIFICATION_COMPLETION  (x64 16 / x86 8 バイト)
typedef struct RIO_NOTIFICATION_COMPLETION {
    RIO_NOTIFICATION_COMPLETION_TYPE Type;
    _Anonymous_e__Union Anonymous;
} RIO_NOTIFICATION_COMPLETION;

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct RIO_NOTIFICATION_COMPLETION
{
    public int Type;
    public _Anonymous_e__Union Anonymous;
}

Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure RIO_NOTIFICATION_COMPLETION
    Public Type As Integer
    Public Anonymous As _Anonymous_e__Union
End Structure

import ctypes
from ctypes import wintypes

class RIO_NOTIFICATION_COMPLETION(ctypes.Structure):
    _fields_ = [
        ("Type", ctypes.c_int),
        ("Anonymous", _Anonymous_e__Union),
    ]

#[repr(C)]
pub struct RIO_NOTIFICATION_COMPLETION {
    pub Type: i32,
    pub Anonymous: _Anonymous_e__Union,
}

import "golang.org/x/sys/windows"

type RIO_NOTIFICATION_COMPLETION struct {
	Type int32
	Anonymous _Anonymous_e__Union
}

type
  RIO_NOTIFICATION_COMPLETION = record
    Type: Integer;
    Anonymous: _Anonymous_e__Union;
  end;

const RIO_NOTIFICATION_COMPLETION = extern struct {
    Type: i32,
    Anonymous: _Anonymous_e__Union,
};

type
  RIO_NOTIFICATION_COMPLETION {.bycopy.} = object
    Type: int32
    Anonymous: _Anonymous_e__Union

struct RIO_NOTIFICATION_COMPLETION
{
    int Type;
    _Anonymous_e__Union Anonymous;
}

HSP用定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; RIO_NOTIFICATION_COMPLETION サイズ: 8 バイト(x86)
dim st, 2    ; 4byte整数×2(構造体サイズ 8 / 4 切り上げ)
; Type : RIO_NOTIFICATION_COMPLETION_TYPE (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Anonymous : _Anonymous_e__Union (+4, 4byte)  varptr(st)+4 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; RIO_NOTIFICATION_COMPLETION サイズ: 16 バイト(x64)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; Type : RIO_NOTIFICATION_COMPLETION_TYPE (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Anonymous : _Anonymous_e__Union (+8, 8byte)  varptr(st)+8 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global RIO_NOTIFICATION_COMPLETION
    #field int Type
    #field byte Anonymous 8
#endstruct

stdim st, RIO_NOTIFICATION_COMPLETION        ; NSTRUCT 変数を確保
st->Type = 100
mes "Type=" + st->Type
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。