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

RIO_BUF

構造体
サイズx64: 16 バイト / x86: 12 バイト

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

フィールド

フィールドサイズx64x86説明
BufferIdRIO_BUFFERID8/4+0+0送信要求および受信要求で使用される、Winsock 登録済み I/O バッファーの登録済みバッファー記述子です。
OffsetDWORD4+8+4BufferId メンバーで指定されたバッファー内へのオフセット (バイト単位)。Offset の値が 0 の場合は、バッファーの先頭を指します。
LengthDWORD4+12+8Offset メンバーの位置から使用するバッファーの長さ (バイト単位)。

公式ドキュメント

RIO_BUF 構造体は、Winsock 登録済み I/O 拡張機能でネットワークデータの送受信に使用される、登録済みバッファーの一部分を指定します。

解説(Remarks)

Winsock 登録済み I/O 拡張機能は、多くの場合、登録済みバッファーの一部分 (バッファースライスと呼ばれることもあります) を対象に動作します。RIO_BUF 構造体は、ネットワークデータの送受信に少量の登録済みメモリを使用する必要があるアプリケーションで使用されます。アプリケーションは、大きなバッファーを 1 つ登録しておき、必要に応じてその一部を小さな単位で使用することで、パフォーマンスを向上できる場合が多くあります。RIO_BUF 構造体は、1 回のバッファー登録に含まれる連続したメモリ領域であれば、任意の区間を記述できます。

RIO_BUF 構造体へのポインターは、ネットワークデータを送受信するために RIOSendRIOSendExRIOReceiveRIOReceiveEx の各関数に pData パラメーターとして渡されます。

アプリケーションは、RIORegisterBuffer 関数で登録した元のバッファーより大きい値を持つバッファースライスを使用しても、登録済みバッファーのサイズを変更することはできません。

RIO_BUF 構造体は Mswsockdef.h ヘッダーファイルで定義されており、このファイルは Mswsock.h ヘッダーファイルに自動的にインクルードされます。Mswsockdef.h ヘッダーファイルを直接使用しないでください。

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

各言語での定義

#include <windows.h>

// RIO_BUF  (x64 16 / x86 12 バイト)
typedef struct RIO_BUF {
    RIO_BUFFERID BufferId;
    DWORD Offset;
    DWORD Length;
} RIO_BUF;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct RIO_BUF
{
    public IntPtr BufferId;
    public uint Offset;
    public uint Length;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure RIO_BUF
    Public BufferId As IntPtr
    Public Offset As UInteger
    Public Length As UInteger
End Structure
import ctypes
from ctypes import wintypes

class RIO_BUF(ctypes.Structure):
    _fields_ = [
        ("BufferId", ctypes.c_ssize_t),
        ("Offset", wintypes.DWORD),
        ("Length", wintypes.DWORD),
    ]
#[repr(C)]
pub struct RIO_BUF {
    pub BufferId: isize,
    pub Offset: u32,
    pub Length: u32,
}
import "golang.org/x/sys/windows"

type RIO_BUF struct {
	BufferId uintptr
	Offset uint32
	Length uint32
}
type
  RIO_BUF = record
    BufferId: NativeInt;
    Offset: DWORD;
    Length: DWORD;
  end;
const RIO_BUF = extern struct {
    BufferId: isize,
    Offset: u32,
    Length: u32,
};
type
  RIO_BUF {.bycopy.} = object
    BufferId: int
    Offset: uint32
    Length: uint32
struct RIO_BUF
{
    ptrdiff_t BufferId;
    uint Offset;
    uint Length;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; RIO_BUF サイズ: 12 バイト(x86)
dim st, 3    ; 4byte整数×3(構造体サイズ 12 / 4 切り上げ)
; BufferId : RIO_BUFFERID (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Offset : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Length : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; RIO_BUF サイズ: 16 バイト(x64)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; BufferId : RIO_BUFFERID (+0, 8byte)  qpoke st,0,値 / qpeek(st,0)  ※IronHSPのみ。3.7/3.8は lpoke st,0,下位 : lpoke st,4,上位
; Offset : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; Length : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global RIO_BUF
    #field intptr BufferId
    #field int Offset
    #field int Length
#endstruct

stdim st, RIO_BUF        ; NSTRUCT 変数を確保
st->BufferId = 100
mes "BufferId=" + st->BufferId