日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.3-RELEASE-K, 13.0-RELEASE-K から 13.2-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
SOURCEFILTER(3) FreeBSD ライブラリ関数マニュアル SOURCEFILTER(3)
名称
sourcefilter -- 高度なマルチキャストグループメンバシップ API
書式
#include <sys/socket.h>
#include <netinet/in.h>
int
getipv4sourcefilter(int s, struct in_addr interface,
struct in_addr group, uint32_t *fmode, uint32_t *numsrc,
struct in_addr *slist);
int
getsourcefilter(int s, uint32_t interface, struct sockaddr *group,
socklen_t grouplen, uint32_t *fmode, uint32_t *numsrc,
struct sockaddr_storage *slist);
int
setipv4sourcefilter(int s, struct in_addr interface,
struct in_addr group, uint32_t fmode, uint32_t numsrc,
struct in_addr *slist);
int
setsourcefilter(int s, uint32_t interface, struct sockaddr *group,
socklen_t grouplen, uint32_t fmode, uint32_t numsrc,
struct sockaddr_storage *slist);
解説
sourcefilter 関数は、RFC 3678 で定義された高度で、完全な状態のマルチキャ
スト API を実装しています。アプリケーションは、ソケット s とマルチキャス
ト group に関連しているマルチキャストソースアドレスフィルタを不可分に設定
して、検索するためにこれらの関数群を使用することができます。
関数 getipv4sourcefilter() と getsourcefilter() によって、アプリケーショ
ンは、既存のグループメンバシップのためのフィルタモードとソースフィルタエ
ントリを発見できます。
カーネルは、*numsrc のそのグループのためのソケットで、常にソースフィルタ
エントリの数を返します。*numsrc 引数が 0 でないなら、カーネルは、slist に
よって指された配列の *numsrc フィルタエントリまで、返すことを試みます。
*numsrc 引数が 0 に設定されている場合、slist 引数は、無視されます。
setipv4sourcefilter() と setsourcefilter() 関数に対して、fmode 引数は、そ
れぞれ MCAST_INCLUDE または MCAST_EXCLUDE 定数を使用することによって、ソ
ケットを包括的 (inclusive) または排他的 (exclusive) なグループメンバシッ
プモードに置くために使用されます。numsrc 引数は、slist 配列のソースエント
リの数を指定します。numsrc 引数に 0 の値があるなら、すべてのソースフィル
タは、ソケットから削除されます。MCAST_INCLUDE フィルタモードであるメンバ
シップからすべてのソースフィルタを削除することは、グループが、そのソケッ
トで残されたままとなります。
プロトコルから独立している関数 setsourcefilter() によって、アプリケーショ
ンは、interface 引数のためのインデックスを渡すことによって、割り当てられ
たプロトコルアドレスがないインタフェースでマルチキャストグループに加える
ことができます。
これらの関数によって行われたどんな変更は、必要に応じてローカルネットワー
クで IGMPv3 および/または MLDv2 ルータに伝達されます。IGMPv3 または MLDv2
ルータが存在していないなら、これらの機能によって行われたソースフィルタリ
ストの変更は、グループに加えるか、または残される変更を除いて、状態変更
は、転送されません。ソースフィルタ状態を維持し続けます。
実装に関する注
これらの関数の IPv4 特有のバージョンは、プロトコルから独立している関数に
関して実装されます。アプリケーションの作者は、効率のためにプロトコルから
独立している関数と IPv6 ネットワークと前方互換を使用することが奨励されて
います。
プロトコルから独立している関数 getsourcefilter() と setsourcefilter() に
ついて、grouplen 引数は、group によって指された構造体のサイズを指定しま
す。これは、異なったアドレスファミリを区別するために必要です。
現在、FreeBSD は、IPv4 プロトコルファミリのためのソースアドレスの選択をサ
ポートしていません、したがって、無数の IPv4 インタフェースがあるマルチ
キャスト API の使用は、推薦されません。いかなる場合でも、インタフェースで
最初に割り当てられた IPv4 アドレスは、IGMP 制御トラフィックのソースアドレ
スとして使用されます。このアドレスが、削除されるか、または変更されるな
ら、結果は、不定です。
戻り値
関数 getsourcefilter(), getipv4sourcefilter(), setsourcefilter(), および
setipv4sourcefilter() は、処理が成功すると値 0 を返します。そうでない場
合、値 -1 が返され、グローバル変数 errno にエラーを示す値が設定されます。
エラー
sourcefilter 関数は、次の理由で失敗するかもしれません:
[EADDRNOTAVAIL] interface 引数が参照するネットワークインタフェースが、
システムで設定されていなかったか、またはシステムが
group のメンバではありません。
[EAFNOSUPPORT] group そして/または、1 つ以上の slist 引数は、システム
でサポートされていないアドレスファミリであるか、または
group と slist 引数のアドレスファミリは、同じではあり
ませんでした。
[EINVAL] group 引数が、マルチキャストアドレスを含んでいません。
fmode 引数が無効です。MCAST_INCLUDE または
MCAST_EXCLUDE のいずれかに設定されていなければなりませ
ん。numsrc または slist 引数がソースリストを指定してい
ません。
[ENOMEM] 要求された操作を実行するために利用可能なメモリが不足し
ています。
関連項目
ip(4), ip6(4), multicast(4), ifmcstat(8)
D. Thaler, B. Fenner, and B. Quinn, Socket Interface Extensions for
Multicast Source Filters, RFC 3678, Jan 2004.
歴史
sourcefilter 関数は、FreeBSD 7.0 ではじめて登場しました。
作者
Bruce M. Simpson <bms@FreeBSD.org>
FreeBSD 12.2 February 13, 2009 FreeBSD 12.2