本文へ移動
Dialova

IRCドキュメント · 上級

CAP:IRCの拡張機能を交渉する

CAP交渉では、クライアントが処理できる拡張機能を選びます。サーバーの一覧は利用可能な機能の提示であり、自動的な有効化ではありません。SASLや分割された機能一覧を扱う場合も、接続の状態を正しく管理することが大切です。

Dialova運営チーム · 確認日

機能一覧を最後まで取得する #

CAP LS 302は現在の機能通知方式を要求します。サーバーが複数行で返す場合、LSの後の * は続きがあることを示します。一覧をすべて受信してから判断してください。sasl=PLAIN,EXTERNALは対応メカニズムを示す値であり、要求する機能名はsaslのままです。

IRCの通信例:Cはクライアント、Sはサーバー
C: CAP LS 302
C: NICK Alice
C: USER alice 0 * :Alice
S: :irc.example CAP * LS * :message-tags server-time
S: :irc.example CAP * LS :batch sasl=PLAIN,EXTERNAL

実装している機能だけを有効にする #

クライアントは機能を選んでCAP REQを送り、ACKが有効化、NAKが拒否を示します。通知されただけの機能を有効扱いにしないでください。LSで受け取った値を、そのまま無条件にREQへコピーすることも避けてください。

IRCの通信例:Cはクライアント、Sはサーバー
C: CAP REQ :server-time sasl
S: :irc.example CAP Alice ACK :server-time sasl

登録中のCAPは、その完了を保留にします。必要な認証を行った後、CAP ENDで登録処理の続行を許可します。TLSソケットが開いただけで、画面に「接続完了」と表示してはいけません。

登録完了後と機能の変更時 #

CAP LISTで有効な機能を確認できます。登録後にCAP REQを使うこともできます。CAP NEWとCAP DELはcap-notifyによる通知です。サービスの停止などで、サーバーが提供する機能が変わる場合があります。取り消された機能が使える前提で続行せず、状態を見直してください。

CAPに対応しない古いサーバー向けに、従来の接続手順を用意することはできます。ただし、アクセス前の認証を必須としている場合、その保護を黙って省略した接続に切り替えるべきではありません。

実際の機能への影響:DialovaとErgoの例 #

Ergoでは、明示的な履歴取得機能を交渉すると、未受信メッセージの自動再送が無効になる場合があります。その機能を要求するクライアントは、名前を認識するだけでなく、必要な履歴の復元も実装する必要があります。Dialovaはその後、ウェブ上の個別メッセージを独自の履歴にも保存します。サーバーとアプリケーションの責任は別です。

出典と確認

例では、明記した接続先を除き、架空のニックネームとドメインを使用しています。特定のネットワークだけにある拡張や設定は、本文で区別しています。