GROUP_FILTER
構造体サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。
フィールド
| フィールド | 型 | サイズ | x64 | x86 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| gf_interface | DWORD | 4 | +0 | +0 | フィルター処理の対象となるマルチキャストグループのローカルインターフェイスのインターフェイスインデックスです。 | ||||||
| gf_group | SOCKADDR_STORAGE | 128 | +8 | +8 | フィルター処理の対象となるマルチキャストアドレスグループです。IPv6 マルチキャストアドレスと IPv4 マルチキャストアドレスのどちらも指定できます。 | ||||||
| gf_fmode | MULTICAST_MODE_TYPE | 4 | +136 | +136 | マルチキャストフィルターモードです。 このメンバーには、Ws2ipdef.h ヘッダーファイルで定義されている MULTICAST_MODE_TYPE 列挙型の値のいずれかを指定できます。このメンバーによって、gf_numsrc メンバーの IP アドレスの一覧を含めるか除外するかが決まります。
| ||||||
| gf_numsrc | DWORD | 4 | +140 | +140 | gf_slist メンバーに格納されているマルチキャストフィルターのソースアドレスエントリの数です。 | ||||||
| gf_slist | SOCKADDR_STORAGE | 128 | +144 | +144 | 対象に含める、または対象から除外するマルチキャストソースアドレスを指定する SOCKADDR_STORAGE 構造体の配列です。これらの IP アドレスは IPv6 アドレスでも IPv4 アドレスでもかまいませんが、gf_group メンバーで指定されたアドレスと同じアドレスファミリー (IPv6 または IPv4) でなければなりません。 |
公式ドキュメント
GROUP_FILTER 構造体は、マルチキャスト IPv6 アドレスまたは IPv4 アドレスに対するマルチキャストフィルターのパラメーターを提供します。
解説(Remarks)
GROUP_FILTER 構造体は、IPv6 または IPv4 のマルチキャストアドレスとともに使用します。GROUP_FILTER 構造体は、SIOCGMSFILTER および SIOCSMSFILTER IOCTL の引数として渡されます。
GROUP_FILTER 構造体、およびマルチキャストプログラミングで使用される関連構造体は、RFC 3768 のセクション 5 および 8.2 における IETF の勧告に基づいています。詳細については、http://www.ietf.org/rfc/rfc3678.txt を参照してください。
Windows Vista 以降では、IPv6 アドレスと IPv4 アドレスをサポートするマルチキャストプログラミング用のソケットオプションが利用できます。これらのソケットオプションは IP に依存せず、IPv6 と IPv4 の両方で使用できます。この IP 非依存のオプションは GROUP_REQ 構造体および GROUP_SOURCE_REQ 構造体を使用するもので、Windows Vista 以降のマルチキャストプログラミングでは推奨されるソケットオプションです。
gf_interface メンバーに必要なインターフェイスインデックスの情報は、GetAdaptersAddresses 関数を使用して取得できます。
GROUP_FILTER 構造体、およびこの構造体を使用する IOCTL は、データグラムソケットと raw ソケット (ソケットの種類が SOCK_DGRAM または SOCK_RAW であるもの) でのみ有効です。
GROUP_FILTER 構造体は Ws2ipdef.h ヘッダーファイルで定義されており、このヘッダーファイルは Ws2tcpip.h ヘッダーファイルに自動的にインクルードされます。Ws2ipdef.h ヘッダーファイルを直接使用しないでください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での定義
#include <windows.h>
// SOCKADDR_STORAGE (x64 128 / x86 128 バイト)
typedef struct SOCKADDR_STORAGE {
ADDRESS_FAMILY ss_family;
CHAR __ss_pad1[6];
LONGLONG __ss_align;
CHAR __ss_pad2[112];
} SOCKADDR_STORAGE;
// GROUP_FILTER (x64 272 / x86 272 バイト)
typedef struct GROUP_FILTER {
DWORD gf_interface;
SOCKADDR_STORAGE gf_group;
MULTICAST_MODE_TYPE gf_fmode;
DWORD gf_numsrc;
SOCKADDR_STORAGE gf_slist[1];
} GROUP_FILTER;using System;
using System.Runtime.InteropServices;
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct SOCKADDR_STORAGE
{
public ushort ss_family;
[MarshalAs(UnmanagedType.ByValArray, SizeConst = 6)] public sbyte[] __ss_pad1;
public long __ss_align;
[MarshalAs(UnmanagedType.ByValArray, SizeConst = 112)] public sbyte[] __ss_pad2;
}
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct GROUP_FILTER
{
public uint gf_interface;
public SOCKADDR_STORAGE gf_group;
public int gf_fmode;
public uint gf_numsrc;
[MarshalAs(UnmanagedType.ByValArray, SizeConst = 1)] public SOCKADDR_STORAGE[] gf_slist;
}Imports System.Runtime.InteropServices
<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure SOCKADDR_STORAGE
Public ss_family As UShort
<MarshalAs(UnmanagedType.ByValArray, SizeConst:=6)> Public __ss_pad1() As SByte
Public __ss_align As Long
<MarshalAs(UnmanagedType.ByValArray, SizeConst:=112)> Public __ss_pad2() As SByte
End Structure
<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure GROUP_FILTER
Public gf_interface As UInteger
Public gf_group As SOCKADDR_STORAGE
Public gf_fmode As Integer
Public gf_numsrc As UInteger
<MarshalAs(UnmanagedType.ByValArray, SizeConst:=1)> Public gf_slist() As SOCKADDR_STORAGE
End Structureimport ctypes
from ctypes import wintypes
class SOCKADDR_STORAGE(ctypes.Structure):
_fields_ = [
("ss_family", ctypes.c_ushort),
("__ss_pad1", ctypes.c_byte * 6),
("__ss_align", ctypes.c_longlong),
("__ss_pad2", ctypes.c_byte * 112),
]
class GROUP_FILTER(ctypes.Structure):
_fields_ = [
("gf_interface", wintypes.DWORD),
("gf_group", SOCKADDR_STORAGE),
("gf_fmode", ctypes.c_int),
("gf_numsrc", wintypes.DWORD),
("gf_slist", SOCKADDR_STORAGE * 1),
]#[repr(C)]
pub struct SOCKADDR_STORAGE {
pub ss_family: u16,
pub __ss_pad1: [i8; 6],
pub __ss_align: i64,
pub __ss_pad2: [i8; 112],
}
#[repr(C)]
pub struct GROUP_FILTER {
pub gf_interface: u32,
pub gf_group: SOCKADDR_STORAGE,
pub gf_fmode: i32,
pub gf_numsrc: u32,
pub gf_slist: [SOCKADDR_STORAGE; 1],
}import "golang.org/x/sys/windows"
type SOCKADDR_STORAGE struct {
ss_family uint16
__ss_pad1 [6]int8
__ss_align int64
__ss_pad2 [112]int8
}
type GROUP_FILTER struct {
gf_interface uint32
gf_group SOCKADDR_STORAGE
gf_fmode int32
gf_numsrc uint32
gf_slist [1]SOCKADDR_STORAGE
}type
SOCKADDR_STORAGE = record
ss_family: Word;
__ss_pad1: array[0..5] of Shortint;
__ss_align: Int64;
__ss_pad2: array[0..111] of Shortint;
end;
GROUP_FILTER = record
gf_interface: DWORD;
gf_group: SOCKADDR_STORAGE;
gf_fmode: Integer;
gf_numsrc: DWORD;
gf_slist: array[0..0] of SOCKADDR_STORAGE;
end;const SOCKADDR_STORAGE = extern struct {
ss_family: u16,
__ss_pad1: [6]i8,
__ss_align: i64,
__ss_pad2: [112]i8,
};
const GROUP_FILTER = extern struct {
gf_interface: u32,
gf_group: SOCKADDR_STORAGE,
gf_fmode: i32,
gf_numsrc: u32,
gf_slist: [1]SOCKADDR_STORAGE,
};type
SOCKADDR_STORAGE {.bycopy.} = object
ss_family: uint16
__ss_pad1: array[6, int8]
__ss_align: int64
__ss_pad2: array[112, int8]
GROUP_FILTER {.bycopy.} = object
gf_interface: uint32
gf_group: SOCKADDR_STORAGE
gf_fmode: int32
gf_numsrc: uint32
gf_slist: array[1, SOCKADDR_STORAGE]struct SOCKADDR_STORAGE
{
ushort ss_family;
byte[6] __ss_pad1;
long __ss_align;
byte[112] __ss_pad2;
}
struct GROUP_FILTER
{
uint gf_interface;
SOCKADDR_STORAGE gf_group;
int gf_fmode;
uint gf_numsrc;
SOCKADDR_STORAGE[1] gf_slist;
}HSP用 定義
HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; GROUP_FILTER サイズ: 272 バイト(x64)
dim st, 68 ; 4byte整数×68(構造体サイズ 272 / 4 切り上げ)
; gf_interface : DWORD (+0, 4byte) st.0 = 値 / 値 = st.0 (lpoke/lpeek も可)
; gf_group : SOCKADDR_STORAGE (+8, 128byte) varptr(st)+8 を基点に操作(128byte:入れ子/配列)
; gf_fmode : MULTICAST_MODE_TYPE (+136, 4byte) st.34 = 値 / 値 = st.34 (lpoke/lpeek も可)
; gf_numsrc : DWORD (+140, 4byte) st.35 = 値 / 値 = st.35 (lpoke/lpeek も可)
; gf_slist : SOCKADDR_STORAGE (+144, 128byte) varptr(st)+144 を基点に操作(128byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global SOCKADDR_STORAGE
#field short ss_family
#field byte __ss_pad1 6
#field int64 __ss_align
#field byte __ss_pad2 112
#endstruct
#defstruct global GROUP_FILTER
#field int gf_interface
#field SOCKADDR_STORAGE gf_group
#field int gf_fmode
#field int gf_numsrc
#field SOCKADDR_STORAGE gf_slist 1
#endstruct
stdim st, GROUP_FILTER ; NSTRUCT 変数を確保
st->gf_interface = 100
mes "gf_interface=" + st->gf_interface