日本語 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
SCTP(4) FreeBSD カーネルインタフェースマニュアル SCTP(4)
名称
sctp -- インターネットストリーム制御転送プロトコル
書式
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/sctp.h>
int
socket(AF_INET, SOCK_STREAM, IPPROTO_SCTP);
int
socket(AF_INET, SOCK_SEQPACKET, IPPROTO_SCTP);
解説
SCTP プロトコルは、データの信頼性、フロー制御、双方向の転送を提供します。
それは、メッセージ指向のプロトコルであり、SOCK_STREAM と SOCK_SEQPACKET
抽象化をサポートすることができます。SCTP は、標準のインターネットアドレス
形式を使用して、さらに、``ポートアドレス'' のホスト毎のコレクション (収
集) を提供します。したがって、各アドレスは、ホスト識別ピア (相手側) 実態
上の特定の SCTP ポートで、ホストとネットワークを指定するインターネットア
ドレスで構成されます。
SCTP のプログラミングに関して 2 つのモデルがあります。最初は、SOCK_STREAM
抽象化を使用します。この抽象化で、SCTP プロトコルを利用するソケットは、
``アクティブ'' (active) または ``パッシブ'' (passive) です。アクティブな
ソケットは、パッシブなソケットに接続を開始します。デフォルトで、SCTP ソ
ケットは、アクティブで作成されます。パッシブなソケットを作成するために
は、bind(2) または sctp_bindx(3) システムコールでソケットをバインドした後
に、listen(2) システムコールを使用しなければなりません。パッシブなソケッ
トだけが、着信接続を受け付けるために accept(2) 呼び出しを使用します。アク
ティブなソケットだけが、接続を開始するために connect(2) 呼び出しを使用し
ます。
別の抽象化 SOCK_SEQPACKET は、ユーザが (ソケットアドレスを運ぶ有効な送信
呼び出しのいずれかを使用して)、アドレスに送信するする点において、
``connectionless'' (コネクションレス) 操作モードを提供し、アソシエーショ
ンは、基本的な SCTP 転送スタックによって暗黙的にセットアップされます。こ
の抽象化は、4 つの方法のハンドシェイクの 3 番目の行程でデータを送信するこ
とができるただ一つのものです。ユーザは、ソケットが接続を受け付けることが
できるように、まだ listen(2) を呼び出さなければなりません。しかしながら、
listen(2) の呼び出しは、まだ他のピアへの暗黙の接続を開始することからユー
ザを禁止しません。
SCTP プロトコルは、直接マルチホーミング (multi-homing) をサポートします。
それで、``ワイルドカード'' のアドレス INADDR_ANY でソケットをバインドする
とき、SCTP スタックは、ピアの範囲で考えられるすべてのローカルのアドレスに
関してピアに情報を与えます。そして、ピアには、たぶんローカルホストに到達
する複数のパスがあります。
また、SCTP 転送プロトコルもマルチストリーム (multi-stream) されます。マル
チストリームは、メッセージのサブ順序付けフローを送信する能力を参照しま
す。ユーザは、sctp_send(3) 関数呼び出しのような、拡張された送信呼び出しの
1 つで特定のストリームを指定することによって、これを実行します。異なった
ストリームでのメッセージの送信は、データの平行な配信を許可します、すなわ
ち、ストリーム 1 におけるメッセージの損失は、ストリーム 2 で送信される
メッセージの配信をブロックしません。
また、SCTP 転送プロトコルは、同様に順序付けされていないサービスを提供しま
す。順序付けされていないサービスによって、他のメッセージの順序に関係しな
いで、メッセージを送信して配信することができます。
拡張
また、SCTP の FreeBSD の実装は、次の拡張をサポートします:
sctp 部分的な信頼性
この拡張によって、いくつかのユーザの指定されたパラメータに基づい
てスキップされ配信されないメッセージを持つことができます。
sctp 動的なアドレス付け
この拡張によって、既存のアソシエーションから動的にアドレスを追加
して、削除することができます。
sctp 認証
この拡張によって、ユーザは、メッセージを送信するピアが、実際にア
ソシエーションをセットアップするピアであることを確認するために
(データを含んでいる) 特定のピアのチャンク (塊) を認証することがで
きます。また、共有されたキーオプションは、2 つのスタックがキーを
前もって共有することができるように、供給されます。
パケットの取りこぼし
いくつかのルータは、不正による損失を報告する特別なサテライト (従
属) プロトコルをサポートしています。これによって、帯域幅の利用に
おいてそれに続く損失なしで再転送することができます。
ストリームのリセット
この拡張によって、どちらかの側のユーザは、いくらか、またはすべて
のストリームで使用されるストリームシーケンス番号をリセットできま
す。
SCTP は、setsockopt(2) で設定され、getsockopt(2) または sctp_opt_info(3)
でテストすることができる、多くのソケットオプションをサポートします:
SCTP_NODELAY
ほとんどの状況において、SCTP は、それが存在しているとき、データ
を送信します。発行済のデータがまだ承認されていないとき、いった
ん承認が受信されると、単一のパケットで送信される少量の出力を収
集します。応答を受信しないマウスイベントのストリームを送信する
ウィンドウシステムのような、いくつかのクライアントに関して、こ
のパケット化は、重要な遅延を引き起こすかもしれません。ブール値
のオプション SCTP_NODELAY は、このアルゴリズムを無効化します。
SCTP_RTOINFO
このオプションは、アソシエーション ``再転送のタイムアウト'' に
関する特有の情報を返します。また、デフォルト値を変更するために
それを使用することができます。
SCTP_ASSOCINFO
このオプションは、要求されたアソシエーションに関する特有の情報
を返します。
SCTP_INITMSG
このオプションによって、利用者は、アソシエーションが暗黙のうち
にセットアップされるときに、デフォルトの送信パラメータを取得す
るか、または設定することができます。それによって、利用者は、内
向きで許可されたストリームの最大の数とピアの要求されたストリー
ムの数としてそのようなものを変更することができ、
SCTP_AUTOCLOSE
1 対多ののモデル (SOCK_SEQPACKET) において、アソシエーション
は、暗黙のうちにセットアップされます。このオプションによって、
ユーザは、アソシエーションを保持することができる、デフォルト番
号のアイドル秒を指定することができます。(ユーザメッセージが送信
されないか、または、ピアから受信されていないところで) アイドル
秒の後に、アソシエーションは、潔くクローズされます。この値のた
めのデフォルトは、0 または無制限 (すなわち、自動的にクローズさ
れない) です。
SCTP_SET_PEER_PRIMARY_ADDR
動的なアドレス拡張によって、ピアは、特定のアドレスがプライマリ
アドレスに作られることも要求できます。このオプションによって、
呼び出し側は、そのような要求をピアに行うことができます。また、
ピアが動的なアドレス拡張をサポートしていないなら、この呼び出し
が、失敗することに注意してください。呼び出し側は、ピアが、アソ
シエーションのセットアップの間または動的に伝える、有効なローカ
ルアドレスを提供しなければならないことに注意してください。
SCTP_PRIMARY_ADDR
このオプションによって、呼び出し側が送信したいプライマリアドレ
スの設定を可能にします。呼び出し側は、プライマリとなるピアのア
ドレスを提供します。
SCTP_ADAPTATION_LAYER
また、動的アドレス拡張によって、ユーザは、アソシエーションの
セットアップで 32 ビットの不透明な (サイズおよび形がわからない)
値を渡すことができます。このオプションによって、ユーザは、この
値を設定するか、または取得できます。
SCTP_DISABLE_FRAGMENTS
デフォルトで、SCTP は、ネットワークに適合し、次に後で、受信にお
いて、断片を単一のユーザメッセージに再構築する、ユーザメッセー
ジを複数の断片に断片化します。代わりにこのオプションが有効にさ
れるなら、パスの最大の転送単位 (P-MTU) を超える任意の送信は、失
敗し、メッセージは、送信されません。
SCTP_PEER_ADDR_PARAMS
このオプションによって、ユーザは、特定のピアアドレスのパラメー
タを設定するか、または取得できます。
SCTP_DEFAULT_SEND_PARAM
ユーザが拡張された送信呼び出し (例えば、sctp_sendmsg(3)) の 1
つを使用しないとき、デフォルト値の組は、それぞれの送信に適用し
ます。これらの値は、プロトコル毎の ID と同様に送信するストリー
ム番号のようなものを含んでいます。このオプションによって、呼び
出し側は、これらの値を取得して、設定できます。ユーザがこれらの
デフォルト値を変更するなら、これらの新しい値は、情報が送信側に
よって提供されない (すなわち、非拡張 API が使用される) ときはい
つも、デフォルトとして使用されます。
SCTP_EVENTS
SCTP には、アプリケーションと通信することができるデータでないイ
ベントがあります。デフォルトで、これらは、受信されたメッセージ
で設定された特別なフラグ MSG_NOTIFICATION でデータパスに到着す
るので、すべて無効にされます。このオプションによって、呼び出し
側は、それらが、受信に関心がある、異なったイベントで設定される
のと同様に現在受信された、イベントを取得できます。
SCTP_I_WANT_MAPPED_V4_ADDR
SCTP は、IPV4 と IPV6 の両方をサポートします。SCTP は、マルチ
ホームであるので、アソシエーションは、IPV4 と IPV6 アドレスの両
方にわたります。デフォルトで、IPV6 ソケットをオープンするとき、
データがソケットでピアの V4 アドレスから到着するとき、V4 アドレ
スは、AF_INET のアドレスファミリで示されます。これが望ましくな
いなら、このオプションを、有効にすることができ、すべての V4 ア
ドレスをマップしている V6 表現に変換します。
SCTP_MAXSEG
デフォルトで、SCTP は、ピアの最も小さい P-MTU に基づくメッセー
ジ断片化ポイントを選択します。このオプションによって、呼び出し
側は、それをより小さい値に設定できます。ユーザは、この値を変更
することができますが、P-MTU がユーザによって設定された値より小
さいなら、P-MTU 値は、任意のユーザ設定を上書きすることに注意し
てください。
SCTP_DELAYED_ACK_TIME
このオプションによって、ユーザは、SCTP が使用する遅延 ack 時間
(ミリ秒単位の) を設定して取得できます。デフォルトは、200 ミリ秒
です。
SCTP_PARTIAL_DELIVERY_POINT
時には、SCTP は、全体のメッセージが到着する前に非常に大きいメッ
セージの配信を始める必要があります。デフォルトで、SCTP は、着信
メッセージが受信バッファの 1/4 より大きくなるまで、ウェートしま
す。このオプションによって、スタックに値は、より小さい値で上書
きすることができます。
SCTP_FRAGMENT_INTERLEAVE
時には、SCTP は、(上記のように) の部分的な配信を開始します。通
常の場合では、連続した読み込みは、必要であるなら、ブロックし
て、そのメッセージのすべてが読み込まれるまで、メッセージの残り
を返し続けます。しかしながら、これは、他のメッセージが到着し
て、配信の準備ができて、部分的に配信されたメッセージの後ろでブ
ロックされることを意味します。このオプションが有効にされている
なら、部分的に配信されたメッセージに、それ以上の受信されるデー
タがないとき、続く読み込みは、配信の準備ができてきる異なった
メッセージを返します。ユーザがメッセージ (ストリームとストリー
ムシーケンス番号を通して) の違いを伝えることができるように拡張
API を使用しなければならないので、このオプションは、デフォルト
で、オフです。
SCTP_AUTH_CHUNK
デフォルトで、動的なアドレシングチャンク (塊) だけが認証されま
す。このオプションによって、ユーザは、追加のチャンク (塊) が同
様に認証されるよう要求できます。このオプションへの連続した呼び
出しは、動作し、認証を必要とするより多くのチャンク (塊) を追加
し続けることに注意してください。このオプションは、今後のアソシ
エーションのみに効果があり、既存のものではないことに注意してく
ださい。
SCTP_AUTH_KEY
このオプションによって、ユーザは、後でピアを認証するために使用
できる共有されたキーを指定できます。
SCTP_HMAC_IDENT
このオプションによって、利用者は、ピアを認証するために使用され
る HMAC アルゴリズムのリストを取得するか、または設定できます。
HMAC 値は、最初の HMAC 識別子が最も好ましく、最後は、最も好まし
くないところの優先順であることに注意してください。
SCTP_AUTH_ACTIVE_KEY
このオプションによって、利用者は、認証情報の生成のためにキーを
アクティブにすることができます。ピアは、同じキーを持たなければ
なりません、さもなければ、データが破棄されることに注意してくだ
さい。
SCTP_AUTH_DELETE_KEY
このオプションによって、利用者は、古いキーを削除できます。
SCTP_USE_EXT_RECVINFO
ソケット API の文書によって、拡張された送信/受信情報構造を使用
できます。拡張された構造は、(現在の受信が完了して後に)、そのよ
うな情報が知られているなら、次の受信されるメッセージに関連する
追加フィールドを含みます。デフォルトで、システムは、この情報を
渡しません。このオプションによって、ユーザは、この情報を要求で
きます。
SCTP_AUTO_ASCONF
デフォルトで、すべてのアドレスとシステム管理者へのバインドが自
動的で動的なアドレスを有効にするとき、SCTP スタックは、このオプ
ションを真に設定することによって、任意のピアへの追加と削除要求
に変更するアドレスを自動的に生成します。このオプションによっ
て、終点 (endpoint) は、その振舞いを無効にすることができます。
SCTP_MAXBURST
デフォルトで、SCTP は、混雑したウィンドウの開始で、パケットの大
きなバーストを生成することができないように、マイクロバースト制
御を実装します。デフォルトのバースト制限は、4 です。このオプ
ションによって、ユーザは、この値を変更することができます。
SCTP_CONTEXT
多くの sctp 拡張呼び出しには、コンテキストフィールドがありま
す。コンテキストフィールドは、送信の失敗で返される 32 ビットの
不透明な値です。このオプションによって、デフォルトのコンテキス
ト値を設定する呼び出し側は、ユーザによってなにも提供されないと
き、使用することができます。
SCTP_EXPLICIT_EOR
デフォルトで、単一の送信は、完全なメッセージです。SCTP は、暗黙
的にレコードの境界を生成します。このオプションが有効にされるな
ら、sctp_sndrcvinfo フラグフィールドで渡される、特別なフラグ
SCTP_EOR でユーザが、レコードの終わりを示すまで、すべて送信は、
同じメッセージの部分です。これは、ユーザが異なって指定するま
で、同じメッセージのすべての送信部分を効果的に作成します。これ
は、呼び出し側が、SCTP_EOR を SCTP に渡す後まで、ストリーム番号
を変更してはならないことを意味し、そうでなければ、エラーが返さ
れます。
SCTP_STATUS
このオプションは、指定されたアソシエーションに関する様々な状態
情報を返す読み込み専用のオプションです。
SCTP_GET_PEER_ADDR_INFO
この読み込み専用のオプションは、ピアアドレスの情報を返します。
SCTP_PEER_AUTH_CHUNKS
この読み込み専用のオプションは、ピアが認証されるのを必要とする
チャンク (塊) のリストを返します。
SCTP_LOCAL_AUTH_CHUNKS
この読み込み専用のオプションは、認証しなければならない局所的に
必要なチャンク (塊) のリストを返します。
SCTP_RESET_STREAMS
このソケットオプションは、ストリームのシーケンス番号、またはす
べてのストリームのシーケンス番号をリセットするために使用されま
す。また、ピアの SCTP 終点は、同様に、ストリームのリセット拡張
をサポートしなければならないことに注意してください。
関連項目
accept(2), bind(2), connect(2), listen(2), sctp_bindx(3),
sctp_connectx(3), sctp_opt_info(3), sctp_recvmsg(3), sctp_sendmsg(3)
FreeBSD 11.2 December 15, 2006 FreeBSD 11.2