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

IP_MSFILTER

構造体
サイズx64: 32 バイト / x86: 20 バイト

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

フィールド

フィールドサイズx64x86説明
imsf_multiaddrIN_ADDR8/4+0+0マルチキャストグループの IPv4 アドレスです。
imsf_interfaceIN_ADDR8/4+8+4

マルチキャストグループをフィルタリングする対象のインターフェイスのローカル IPv4 アドレス、またはインターフェイスインデックスです。この値はネットワークバイトオーダーです。このメンバーに IPv4 アドレス 0.0.0.0 を指定した場合は、既定の IPv4 マルチキャストインターフェイスが使用されます。

インターフェイスインデックスとして 1 を使用することは、IP アドレス 0.0.0.1 を指定することと同じです。

imsf_fmodeMULTICAST_MODE_TYPE4+16+8

使用するマルチキャストフィルターモードです。このパラメーターには、特定のマルチキャストソースを含める MCAST_INCLUDE (値は 0)、または指定したソースからのトラフィックを除外する MCAST_EXCLUDE (値は 1) のいずれかを指定できます。

Windows Server 2003 および Windows XP では、これらの値は Ws2tcpip.h ヘッダーファイルで定義されています。

Windows Vista 以降では、これらの値は Ws2ipdef.h ヘッダーファイルで定義されている MULTICAST_MODE_TYPE 列挙型の列挙値として定義されています。

imsf_numsrcDWORD4+20+12imsf_slist メンバー内のソースの数です。
imsf_slistIN_ADDR8/4+24+16含める、または除外する IPv4 マルチキャストソースアドレスを指定する in_addr 構造体の配列です。

公式ドキュメント

ip_msfilter 構造体は、IPv4 アドレス用のマルチキャストフィルタリングパラメーターを提供します。

解説(Remarks)

ip_msfilter 構造体は IPv4 アドレスで使用されます。ip_msfilter 構造体は、SIO_GET_MULTICAST_FILTER および SIO_SET_MULTICAST_FILTER IOCTL の引数として渡されます。

IPv4 マルチキャストプログラミングで使用される ip_msfilter 構造体および関連する構造体は、RFC 3768 のセクション 4 と 8.1 に記載された IETF の推奨に基づいています。詳細については、http://www.ietf.org/rfc/rfc3678.txt を参照してください。

Windows Vista 以降では、IPv6 アドレスと IPv4 アドレスの両方をサポートする、マルチキャストプログラミング用の一連のソケットオプションが利用できます。これらのソケットオプションは IP に依存せず、IPv6 と IPv4 の両方で使用できます。これらの IP 非依存のオプションでは、GROUP_REQ 構造体および GROUP_SOURCE_REQ 構造体と、SIOCSMSFILTER および SIOCGMSFILTER IOCTL を使用します。Windows Vista 以降でのマルチキャストプログラミングでは、これらのソケットオプションと IOCTL の使用が推奨されます。

imsf_interface メンバーにはインターフェイスインデックスを指定できます。0.x.x.x ブロック (最初のオクテットが 0) の IPv4 アドレスは、IPv4 アドレス 0.0.0.0 を除き、インターフェイスインデックスとして扱われます。 インターフェイスインデックスは 24 ビットの数値です。0.0.0.0/8 の IPv4 アドレスブロックは使用されません (この範囲は予約済みです)。imsf_interface メンバーに使用するインターフェイスインデックスの情報は、GetAdaptersAddresses 関数を使用して取得できます。

既定のインターフェイスを使用するのではなく、ip_msfilter 構造体の imsf_interface メンバーには常にローカルの IPv4 アドレスまたはインターフェイスインデックスを指定することを推奨します。 これは、複数のネットワークインターフェイスと複数のパブリック IPv4 アドレスを持つコンピューターでは特に重要です。

IPv4 マルチキャストに使用される既定のインターフェイスは、Windows のネットワークスタックによって決定されます。アプリケーションは、GetIpForwardTable 関数で IPv4 ルーティングテーブルを取得することにより、IPv4 マルチキャストに使用される既定のインターフェイスを判別できます。宛先 IP アドレス 224.0.0.0 に対するルーティングメトリックの値が最も小さいネットワークインターフェイスが、IPv4 マルチキャストの既定のインターフェイスです。ルーティングテーブルは、コマンドプロンプトから次のコマンドで表示することもできます。

route print

IP_MULTICAST_IF ソケットオプションを使用すると、IPv4 マルチキャストパケットを送信する既定のインターフェイスを設定できます。このソケットオプションでは、IPv4 マルチキャストパケットの受信に使用される既定のインターフェイスは変更されません。

一般的な IPv4 マルチキャストアプリケーションでは、IP_ADD_MEMBERSHIP ソケットオプションと ip_mreq 構造体、または IP_ADD_SOURCE_MEMBERSHIP ソケットオプションと ip_mreq_source 構造体を使用してマルチキャストグループに参加し、特定のインターフェイス上でマルチキャストパケットを受信します。IP_MULTICAST_IF ソケットオプションは、マルチキャストグループへ IPv4 マルチキャストパケットを送信するインターフェイスを設定するために使用します。最も一般的なシナリオは、マルチキャストグループに対して同じインターフェイスで受信と送信を行うマルチキャストアプリケーションです。マルチキャストアプリケーションでは、受信用に 1 つのソケット、送信用に 1 つ以上のソケットというように、複数のソケットを使用する場合もあります。

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

メモ IP_MSFILTER および PIP_MSFILTER の派生構造体は、Windows Vista 以降でリリースされた Windows SDK でのみ定義されています。それ以前のバージョンの Windows SDK では、ip_msfilter 構造体を使用してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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;

// IP_MSFILTER  (x64 32 / x86 20 バイト)
typedef struct IP_MSFILTER {
    IN_ADDR imsf_multiaddr;
    IN_ADDR imsf_interface;
    MULTICAST_MODE_TYPE imsf_fmode;
    DWORD imsf_numsrc;
    IN_ADDR imsf_slist[1];
} IP_MSFILTER;
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 IP_MSFILTER
{
    public IN_ADDR imsf_multiaddr;
    public IN_ADDR imsf_interface;
    public int imsf_fmode;
    public uint imsf_numsrc;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 1)] public IN_ADDR[] imsf_slist;
}
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 IP_MSFILTER
    Public imsf_multiaddr As IN_ADDR
    Public imsf_interface As IN_ADDR
    Public imsf_fmode As Integer
    Public imsf_numsrc As UInteger
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=1)> Public imsf_slist() As IN_ADDR
End Structure
import ctypes
from ctypes import wintypes

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

class IP_MSFILTER(ctypes.Structure):
    _fields_ = [
        ("imsf_multiaddr", IN_ADDR),
        ("imsf_interface", IN_ADDR),
        ("imsf_fmode", ctypes.c_int),
        ("imsf_numsrc", wintypes.DWORD),
        ("imsf_slist", IN_ADDR * 1),
    ]
#[repr(C)]
pub struct IN_ADDR {
    pub S_un: _S_un_e__Union,
}

#[repr(C)]
pub struct IP_MSFILTER {
    pub imsf_multiaddr: IN_ADDR,
    pub imsf_interface: IN_ADDR,
    pub imsf_fmode: i32,
    pub imsf_numsrc: u32,
    pub imsf_slist: [IN_ADDR; 1],
}
import "golang.org/x/sys/windows"

type IN_ADDR struct {
	S_un _S_un_e__Union
}

type IP_MSFILTER struct {
	imsf_multiaddr IN_ADDR
	imsf_interface IN_ADDR
	imsf_fmode int32
	imsf_numsrc uint32
	imsf_slist [1]IN_ADDR
}
type
  IN_ADDR = record
    S_un: _S_un_e__Union;
  end;

  IP_MSFILTER = record
    imsf_multiaddr: IN_ADDR;
    imsf_interface: IN_ADDR;
    imsf_fmode: Integer;
    imsf_numsrc: DWORD;
    imsf_slist: array[0..0] of IN_ADDR;
  end;
const IN_ADDR = extern struct {
    S_un: _S_un_e__Union,
};

const IP_MSFILTER = extern struct {
    imsf_multiaddr: IN_ADDR,
    imsf_interface: IN_ADDR,
    imsf_fmode: i32,
    imsf_numsrc: u32,
    imsf_slist: [1]IN_ADDR,
};
type
  IN_ADDR {.bycopy.} = object
    S_un: _S_un_e__Union

  IP_MSFILTER {.bycopy.} = object
    imsf_multiaddr: IN_ADDR
    imsf_interface: IN_ADDR
    imsf_fmode: int32
    imsf_numsrc: uint32
    imsf_slist: array[1, IN_ADDR]
struct IN_ADDR
{
    _S_un_e__Union S_un;
}

struct IP_MSFILTER
{
    IN_ADDR imsf_multiaddr;
    IN_ADDR imsf_interface;
    int imsf_fmode;
    uint imsf_numsrc;
    IN_ADDR[1] imsf_slist;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; IP_MSFILTER サイズ: 20 バイト(x86)
dim st, 5    ; 4byte整数×5(構造体サイズ 20 / 4 切り上げ)
; imsf_multiaddr : IN_ADDR (+0, 4byte)  varptr(st)+0 を基点に操作(4byte:入れ子/配列)
; imsf_interface : IN_ADDR (+4, 4byte)  varptr(st)+4 を基点に操作(4byte:入れ子/配列)
; imsf_fmode : MULTICAST_MODE_TYPE (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; imsf_numsrc : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; imsf_slist : IN_ADDR (+16, 4byte)  varptr(st)+16 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; IP_MSFILTER サイズ: 32 バイト(x64)
dim st, 8    ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; imsf_multiaddr : IN_ADDR (+0, 8byte)  varptr(st)+0 を基点に操作(8byte:入れ子/配列)
; imsf_interface : IN_ADDR (+8, 8byte)  varptr(st)+8 を基点に操作(8byte:入れ子/配列)
; imsf_fmode : MULTICAST_MODE_TYPE (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; imsf_numsrc : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; imsf_slist : IN_ADDR (+24, 8byte)  varptr(st)+24 を基点に操作(8byte:入れ子/配列)
; ※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 IP_MSFILTER
    #field IN_ADDR imsf_multiaddr
    #field IN_ADDR imsf_interface
    #field int imsf_fmode
    #field int imsf_numsrc
    #field IN_ADDR imsf_slist 1
#endstruct

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