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

IN_PKTINFO

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

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

フィールド

フィールドサイズx64x86説明
ipi_addrIN_ADDR8/4+0+0LPFN_WSARECVMSG (WSARecvMsg) 関数で使用する場合は、受信したパケットの IP ヘッダーに含まれる宛先 IPv4 アドレスです。WSASendMsg 関数で使用する場合は、IP ヘッダーに設定するローカルの送信元 IPv4 アドレスです。
ipi_ifindexDWORD4+8+4LPFN_WSARECVMSG (WSARecvMsg) 関数で使用する場合は、パケットを受信したインターフェイスです。WSASendMsg 関数で使用する場合は、パケットの送信に使用するインターフェイスです。

公式ドキュメント

in_pktinfo 構造体は、受信したパケットのアドレス情報を格納するために使用されます。Windows が受信パケットに関する情報を返すために使用するほか、パケットの送信に使用するローカル IPv4 アドレスを指定することもできます。

解説(Remarks)

SOCK_DGRAM または SOCK_RAW 型のソケットに IP_PKTINFO ソケットオプションが設定されている場合、LPFN_WSARECVMSG (WSARecvMsg) 関数が返す制御データオブジェクトの 1 つに、受信したパケットのアドレス情報を格納する in_pktinfo 構造体が含まれます。

SOCK_DGRAM または SOCK_RAW 型の IPv4 ソケットでは、アプリケーションは WSASendMsg 関数による送信に使用するローカル IP アドレスを指定できます。WSASendMsg 関数に WSAMSG 構造体で渡される制御データオブジェクトの 1 つに、送信に使用するローカル IPv4 アドレスを指定する in_pktinfo 構造体を含めることができます。

Windows Vista 以降向けにリリースされた Microsoft Windows Software Development Kit (SDK) では、ヘッダーファイルの構成が変更され、in_pktinfo 構造体は Ws2ipdef.h ヘッダーファイルで定義されています。このヘッダーファイルは Ws2tcpip.h ヘッダーファイルに自動的にインクルードされます。Ws2ipdef.h ヘッダーファイルを直接使用しないでください。

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

各言語での定義

#include <windows.h>

// IN_ADDR  (x64 8 / x86 4 バイト)
typedef struct IN_ADDR {
    _S_un_e__Union S_un;
} IN_ADDR;

// IN_PKTINFO  (x64 16 / x86 8 バイト)
typedef struct IN_PKTINFO {
    IN_ADDR ipi_addr;
    DWORD ipi_ifindex;
} IN_PKTINFO;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct IN_ADDR
{
    public _S_un_e__Union S_un;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct IN_PKTINFO
{
    public IN_ADDR ipi_addr;
    public uint ipi_ifindex;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure IN_ADDR
    Public S_un As _S_un_e__Union
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure IN_PKTINFO
    Public ipi_addr As IN_ADDR
    Public ipi_ifindex As UInteger
End Structure
import ctypes
from ctypes import wintypes

class IN_ADDR(ctypes.Structure):
    _fields_ = [
        ("S_un", _S_un_e__Union),
    ]

class IN_PKTINFO(ctypes.Structure):
    _fields_ = [
        ("ipi_addr", IN_ADDR),
        ("ipi_ifindex", wintypes.DWORD),
    ]
#[repr(C)]
pub struct IN_ADDR {
    pub S_un: _S_un_e__Union,
}

#[repr(C)]
pub struct IN_PKTINFO {
    pub ipi_addr: IN_ADDR,
    pub ipi_ifindex: u32,
}
import "golang.org/x/sys/windows"

type IN_ADDR struct {
	S_un _S_un_e__Union
}

type IN_PKTINFO struct {
	ipi_addr IN_ADDR
	ipi_ifindex uint32
}
type
  IN_ADDR = record
    S_un: _S_un_e__Union;
  end;

  IN_PKTINFO = record
    ipi_addr: IN_ADDR;
    ipi_ifindex: DWORD;
  end;
const IN_ADDR = extern struct {
    S_un: _S_un_e__Union,
};

const IN_PKTINFO = extern struct {
    ipi_addr: IN_ADDR,
    ipi_ifindex: u32,
};
type
  IN_ADDR {.bycopy.} = object
    S_un: _S_un_e__Union

  IN_PKTINFO {.bycopy.} = object
    ipi_addr: IN_ADDR
    ipi_ifindex: uint32
struct IN_ADDR
{
    _S_un_e__Union S_un;
}

struct IN_PKTINFO
{
    IN_ADDR ipi_addr;
    uint ipi_ifindex;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; IN_PKTINFO サイズ: 8 バイト(x86)
dim st, 2    ; 4byte整数×2(構造体サイズ 8 / 4 切り上げ)
; ipi_addr : IN_ADDR (+0, 4byte)  varptr(st)+0 を基点に操作(4byte:入れ子/配列)
; ipi_ifindex : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; IN_PKTINFO サイズ: 16 バイト(x64)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; ipi_addr : IN_ADDR (+0, 8byte)  varptr(st)+0 を基点に操作(8byte:入れ子/配列)
; ipi_ifindex : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global IN_ADDR
    #field byte S_un 8
#endstruct

#defstruct global IN_PKTINFO
    #field IN_ADDR ipi_addr
    #field int ipi_ifindex
#endstruct

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