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

IP_MREQ_SOURCE

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

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

フィールド

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

マルチキャストグループへの参加、脱退、ブロック、またはブロック解除を行うインターフェイスのローカル IPv4 アドレス、またはインターフェイスインデックスです。この値はネットワークバイトオーダーです。このメンバーが IPv4 アドレス 0.0.0.0 を指定した場合は、既定の IPv4 マルチキャストインターフェイスが使用されます。

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

公式ドキュメント

ip_mreq_source 構造体は、IPv4 アドレスのマルチキャストグループ情報を提供します。

解説(Remarks)

ip_mreq_source 構造体は IPv4 アドレスで使用されます。ip_mreq_source 構造体は、IP_ADD_SOURCE_MEMBERSHIPIP_BLOCK_SOURCEIP_DROP_SOURCE_MEMBERSHIPIP_UNBLOCK_SOURCE の各ソケットオプションと共に使用されます。

ip_mreq_source 構造体および IPv4 マルチキャストプログラミングで使用される関連構造体は、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 構造体を使用し、Windows Vista 以降でのマルチキャストプログラミングにおいて推奨されるソケットオプションです。詳細については、Multicast Programming を参照してください。

設定項目の少ない簡易なマルチキャスト機能を IPv4 で使用する場合は、ip_mreq 構造体を使用します。IPv6 の場合は ipv6_mreq 構造体を使用します。

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

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

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

route print

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

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

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

Note IP_MREQ_SOURCE および PIP_MREQ_SOURCE の派生構造体は、Windows Vista 以降でリリースされた Windows SDK でのみ定義されています。それより前のバージョンの Windows SDK では ip_mreq_source 構造体を使用してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_MREQ_SOURCE  (x64 24 / x86 12 バイト)
typedef struct IP_MREQ_SOURCE {
    IN_ADDR imr_multiaddr;
    IN_ADDR imr_sourceaddr;
    IN_ADDR imr_interface;
} IP_MREQ_SOURCE;
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_MREQ_SOURCE
{
    public IN_ADDR imr_multiaddr;
    public IN_ADDR imr_sourceaddr;
    public IN_ADDR imr_interface;
}
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_MREQ_SOURCE
    Public imr_multiaddr As IN_ADDR
    Public imr_sourceaddr As IN_ADDR
    Public imr_interface 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_MREQ_SOURCE(ctypes.Structure):
    _fields_ = [
        ("imr_multiaddr", IN_ADDR),
        ("imr_sourceaddr", IN_ADDR),
        ("imr_interface", IN_ADDR),
    ]
#[repr(C)]
pub struct IN_ADDR {
    pub S_un: _S_un_e__Union,
}

#[repr(C)]
pub struct IP_MREQ_SOURCE {
    pub imr_multiaddr: IN_ADDR,
    pub imr_sourceaddr: IN_ADDR,
    pub imr_interface: IN_ADDR,
}
import "golang.org/x/sys/windows"

type IN_ADDR struct {
	S_un _S_un_e__Union
}

type IP_MREQ_SOURCE struct {
	imr_multiaddr IN_ADDR
	imr_sourceaddr IN_ADDR
	imr_interface IN_ADDR
}
type
  IN_ADDR = record
    S_un: _S_un_e__Union;
  end;

  IP_MREQ_SOURCE = record
    imr_multiaddr: IN_ADDR;
    imr_sourceaddr: IN_ADDR;
    imr_interface: IN_ADDR;
  end;
const IN_ADDR = extern struct {
    S_un: _S_un_e__Union,
};

const IP_MREQ_SOURCE = extern struct {
    imr_multiaddr: IN_ADDR,
    imr_sourceaddr: IN_ADDR,
    imr_interface: IN_ADDR,
};
type
  IN_ADDR {.bycopy.} = object
    S_un: _S_un_e__Union

  IP_MREQ_SOURCE {.bycopy.} = object
    imr_multiaddr: IN_ADDR
    imr_sourceaddr: IN_ADDR
    imr_interface: IN_ADDR
struct IN_ADDR
{
    _S_un_e__Union S_un;
}

struct IP_MREQ_SOURCE
{
    IN_ADDR imr_multiaddr;
    IN_ADDR imr_sourceaddr;
    IN_ADDR imr_interface;
}

HSP用 定義

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

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

stdim st, IP_MREQ_SOURCE        ; NSTRUCT 変数を確保