設定ファイル仕様

1 概要

porter は INI 形式のテキストファイルでサービスを定義します。
1 つの設定ファイルに定義できるサービス数に上限はありません (初期バッファ容量は 64 で、超過時は自動拡張されます)。

potrOpenServiceFromConfig() 呼び出し時にファイルを読み込み、指定した service_id のエントリを使用します。
以後はファイルを参照しないため、起動後にファイルを変更しても動作に影響はありません。
potrOpenService() を直接呼ぶ場合は設定ファイルを使用せず、PotrGlobalConfig / PotrServiceDef 構造体を直接渡します。

2 ファイル形式

[global]
キー = 値

[service.サービスID]
キー = 値

• セクション名は [global] と [service.数値] の 2 種類です。
• コメントは # または ; で始まる行です。
• 値前後の空白は無視されます。

3 \[global\] セクション

すべてのサービスに適用されるグローバル設定です。

3.1 window_size の影響

ウィンドウサイズは再送可能な過去パケット数の上限です。
送信側ウィンドウが満杯になると最古エントリが evict (削除) されます。
evict 済みの通番を受信者が NACK で要求した場合、REJECT を返します。

通信の安定性を高めるには、往復遅延時間と送信レートに応じてウィンドウサイズを調整してください。

3.2 max_payload の影響

ペイロードエレメント 1 個分のデータサイズ上限です。
potrSend() で送信するデータがこのサイズを超える場合、複数のフラグメントに分割されます。

3.3 reorder_timeout_ms の使い所

• 設定値を大きくするほど、追い越しを吸収できるが NACK の遅延 (= 再送遅延) も増加する。
• RAW モードでは DISCONNECTED の遅延にも直結するため、リアルタイム性の要件と合わせて調整すること。
• タイムアウト経過後も欠落パケットが届いた場合は NACK なしで正常にウィンドウへ取り込まれる (次の process_outer_pkt 呼び出しで自動検出)。

3.4 マルチキャスト/ブロードキャスト通常モードでの NACK 分散

multicast / broadcast の通常モードかつ reorder_timeout_ms > 0 の場合、複数の受信者が同一欠番を同時に NACK すると送信者への負荷が集中する (NACK implosion)。

これを回避するため、タイマー起動時に 100%〜200% の範囲でランダムなジッタを自動付加します。

• ジッタは monotonic クロックのナノ秒部を乱数源とするため、外部 RNG への依存はありません。
• reorder_timeout_ms = 20 に設定すると実際のタイマーは 20〜40 ms の範囲に分散されます。
• NACK が遅延する分だけ再送が遅れる可能性があるため、reorder_timeout_ms の設定値には余裕を持たせてください。

3.5 health_interval_ms と health_timeout_ms の関係

3.5.1 UDP 通信種別（unicast / multicast / broadcast / unicast_bidir / unicast_bidir_n1 / RAW モード）

3.5.2 TCP 通信種別（tcp / tcp_bidir）

UDP の udp_health_timeout_ms は RECEIVER 側の受信無音タイムアウトですが、
TCP の tcp_health_timeout_ms は SENDER 側の PING 応答待機タイムアウトです。
また TCP では DATA 送信頻度に関わらず tcp_health_interval_ms 周期で PING を送信します
（UDP は DATA が流れていれば PING を省略）。

4 \[service.N\] セクション

N には整数のサービス ID を指定します。

4.1 全通信種別で共通のフィールド

4.2 unicast 専用フィールド

4.3 multicast 専用フィールド

4.4 unicast_raw / multicast_raw / broadcast_raw (RAW モード)

RAW モードは通常モード (unicast / multicast / broadcast) と同一のアドレス・ポートフィールドを使用します。
追加の専用フィールドはありません。

通常モードとの差異:

RAW モードでもスライディングウィンドウによる 順序整列 と セッション管理 は有効です。

4.5 unicast_bidir 専用フィールド

unicast_bidir は常に 1:1 双方向通信 です。SENDER・RECEIVER の双方が独立して送受信・NACK・ヘルスチェックを行います。

4.6 unicast_bidir_n1 専用フィールド

unicast_bidir_n1 は N:1 双方向通信 です。サーバ (POTR_ROLE_RECEIVER) が複数クライアントを同時に受け入れます。クライアントは unicast_bidir (1:1) として接続します。

4.7 tcp / tcp_bidir 専用フィールド

tcp / tcp_bidir では使用しないフィールド（記述しても無視）

4.8 TCP マルチパス設定

dst_addr 〜 dst_addr.3（最大 4 エントリ）に接続先アドレスを設定すると、
各エントリに対して独立した TCP 接続（path）が確立されます。
エントリが 1 つのみの場合は単一接続として動作します。

[service.1]
type         = tcp
dst_addr     = 192.168.1.10   # path 0
dst_addr.1   = 192.168.2.10   # path 1
dst_port     = 5000
src_addr     = 192.168.1.20   # path 0 の bind アドレス
src_addr.1   = 192.168.2.20   # path 1 の bind アドレス

4.8.1 SENDER の bind 動作（src_addr / src_port の組み合わせ）

各 path[i] に独立して適用されます。

4.8.2 RECEIVER の接続フィルタ動作（src_addr / src_port の組み合わせ）

各 path[i] の accept() 後に接続元を検証します。

4.9 broadcast 専用フィールド

4.10 encrypt_key の詳細

encrypt_key を設定すると AES-256-GCM による暗号化・認証タグが有効になります。

4.10.1 ノンス構成

GCM ノンス (12 バイト) は以下の構成です。

[session_id: 4B NBO][flags: 2B NBO][seq_or_ack_num: 4B NBO][padding: 2B 0x00]

各パケット種別の flags 値 (例):

src_addr・dst_addr には以下のいずれかを指定できます。

• IPv4 アドレス (例: 192.168.1.10)
• DNS で解決できるホスト名 (例: receiver.local)

4.11 DNS 解決のポリシー

5 通信種別ごとのソケット動作

5.1 unicast (1:1 通信)

受信者は dst_addr でソケットを bind するため、dst_addr は当該ホストの NIC に割り当てられているアドレスでなければなりません。

5.2 unicast_bidir

5.2.1 1:1 モード

5.2.2 N:1 モード (unicast_bidir_n1)

5.3 multicast (1:N 通信)

5.4 broadcast (1:N 通信)

5.5 tcp / tcp_bidir (TCP 接続)

RECEIVER が先に potrOpenServiceFromConfig() / potrOpenService() を呼んで listen() に入っている必要があります。

6 送信元フィルタリング

受信スレッドは通信種別とモードに応じて送信元を検査します。

• unicast / multicast / broadcast: src_addr を用いて送信元 IP アドレスを照合します
• unicast_bidir (src_addr 指定): src_addr で送信元 IP アドレスを照合します
• unicast_bidir (src_addr 省略・RECEIVER 動的学習): 学習前は全受け入れ、学習後は学習済みアドレスから受信します。セッション追跡により 1:1 が保証されます
• unicast_bidir_n1: src_addr は照合しません。src_port が 0 以外のときのみ送信元ポートを照合します

一致しないパケットはアプリケーション層で破棄します。

6.1 1:1 モードと N:1 モードの使い分け

7 マルチパス設定

最大 4 経路を並列に設定できます。
各経路は独立した UDP ソケットを持ちます。

[service.1001]
type     = unicast

; 経路 0
src_addr = 192.168.1.20
dst_addr = 192.168.1.10
dst_port = 5001

; 経路 1
src_addr.1 = 10.0.0.20
dst_addr.1 = 10.0.0.10

; 経路 2
src_addr.2 = 172.16.0.20
dst_addr.2 = 172.16.0.10

マルチパスを使用すると、DATA・PING・再送パケットがすべての経路へ同時送信されます。

8 サンプル設定ファイル

[global]
window_size        = 16
max_payload        = 1400
health_interval_ms = 3000
health_timeout_ms  = 10000

; ---- ユニキャスト ----
[service.1001]
type     = unicast
src_addr = 192.168.1.20
dst_addr = 192.168.1.10
dst_port = 5001

; ホスト名でも指定可能
[service.1002]
type     = unicast
src_addr = sender.local
dst_addr = receiver.local
dst_port = 5002

; ---- マルチキャスト ----
[service.2001]
type            = multicast
src_addr        = 192.168.1.20
dst_port        = 6001
multicast_group = 224.0.0.1
ttl             = 1

; ---- ブロードキャスト ----
[service.3001]
type           = broadcast
src_addr       = 192.168.1.20
dst_port       = 7001
broadcast_addr = 192.168.1.255

; ---- RAW モード (ベストエフォート) ----
[service.1021]
type      = unicast_raw
src_addr  = 127.0.0.1
dst_addr  = 127.0.0.1
dst_port  = 5021

[service.2021]
type            = multicast_raw
src_addr        = 127.0.0.1
dst_port        = 6021
multicast_group = 239.0.0.21
ttl             = 1

; ---- AES-256-GCM 暗号化 (encrypt_key に 64 文字の16進数文字列を指定) ----
[service.1010]
type        = unicast
src_addr    = 192.168.1.20
dst_addr    = 192.168.1.10
dst_port    = 5010
encrypt_key = 0a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f0a1b2c3d4e5f6a7b8c9d0e1f2a3b

; ---- UDP unicast 双方向 (1:1) ----

; ループバック（Side A: SENDER ロール）
[service.4020]
type      = unicast_bidir
src_addr  = 127.0.0.1
src_port  = 9020
dst_addr  = 127.0.0.1
dst_port  = 9021

; ループバック（Side B: RECEIVER ロール）
[service.4021]
type      = unicast_bidir
src_addr  = 127.0.0.1
src_port  = 9021
dst_addr  = 127.0.0.1
dst_port  = 9020

; ---- UDP unicast 双方向 (N:1 サーバ) ----

; N:1 サーバ: dst_port で待ち受ける (全クライアント受け入れ)
[service.4050]
type      = unicast_bidir_n1
dst_addr  = 0.0.0.0
dst_port  = 9050
max_peers = 256

; N:1 サーバ: src_port を使って送信元ポートをフィルタする例
[service.4051]
type      = unicast_bidir_n1
src_port  = 19050
dst_addr  = 192.168.1.10
dst_port  = 9051
max_peers = 64

; N:1 サーバへ接続するクライアント (unicast_bidir 1:1 として接続)
[service.4052]
type      = unicast_bidir
src_addr  = 192.168.1.20
src_port  = 19050
dst_addr  = 192.168.1.10
dst_port  = 9051

; AES-256-GCM 暗号化
[service.4031]
type        = unicast_bidir
src_addr    = 192.168.1.10
src_port    = 9031
dst_addr    = 192.168.1.20
dst_port    = 9031
encrypt_key = mysecretphrase

; ---- TCP ユニキャスト ----

; 基本設定（ループバック）
[service.5001]
type     = tcp
dst_addr = 127.0.0.1
dst_port = 9001

; 再接続設定あり
[service.5002]
type                  = tcp
dst_addr              = 192.168.1.100
dst_port              = 9002
reconnect_interval_ms = 5000    ; SENDER のみ有効
connect_timeout_ms    = 10000   ; SENDER のみ有効

; AES-256-GCM 暗号化
[service.5003]
type        = tcp
dst_addr    = 192.168.1.100
dst_port    = 9003
encrypt_key = mysecretphrase

; 再接続なし（切断後に自動復帰しない）
[service.5004]
type                  = tcp
dst_addr              = 192.168.1.100
dst_port              = 9004
reconnect_interval_ms = 0

; ---- TCP 双方向 ----

[service.5010]
type                  = tcp_bidir
dst_addr              = 192.168.1.100
dst_port              = 9010
reconnect_interval_ms = 5000    ; SENDER のみ有効
connect_timeout_ms    = 10000   ; SENDER のみ有効