DataChannel シグナリングの type: close の定義を追加

Author: zztkm

CHANGES.md

@@ -26,6 +26,9 @@
   - @zztkm
 - [ADD] サイマルキャストの映像のエンコーディングパラメーター `scaleResolutionDownTo` を追加する
   - @zztkm
+- [ADD] Sora から DataChannel シグナリングを切断する際に "type": "close" メッセージを受信する機能を追加する
+  - DataChannel シグナリングが有効、かつ ignore_disconnect_websocket が true、かつ Sora の設定で data_channel_signaling_close_message が有効な場合に受信することが可能
+  - @zztkm
 - [FIX] Sora から切断された場合の切断処理を修正し適切なエラーを ``MediaChannelHandlers.onDisconnect`` で受け取ることができるようにする
   - Sora iOS SDK 2025.1.1 までは Sora から Close Frame を受け取ったり、ネットワークエラーが起きたりしても、WebSocket メッセージ受信失敗に起因する ``SoraError.webSocketError`` しか受信できなかったが、以下の内容を受信できるようになった
     - Sora から Close Frame を受け取った場合のステータスコードと理由

Sora/Signaling.swift

@@ -132,6 +132,10 @@ public enum Signaling {
   /// "redirect" シグナリング
   case redirect(SignalingRedirect)
 
+  /// type: "close" は DataChannel シグナリング利用時に
+  /// `ignore_disconnect_websocket`: true かつ、`data_channel_signaling_close_message`: true の場合に受信する
+  case close(SignalingClose)
+
   /// :nodoc:
   public static func decode(_ data: Data) -> Result<Signaling, Error> {
     do {
@@ -175,6 +179,8 @@ public enum Signaling {
       return "switched"
     case .redirect:
       return "redirect"
+    case .close:
+      return "close"
     }
   }
 }
@@ -515,6 +521,15 @@ public struct SignalingRedirect {
   public var location: String
 }
 
+/// type: "close" シグナリングメッセージを表す
+/// Sora から受信するメッセージなのでエンコーダーは実装していない
+public struct SignalingClose {
+  /// ステータスコード
+  public var code: Int
+  /// 切断理由
+  public var reason: String
+}
+
 /// "notify" シグナリングメッセージを表します。
 public struct SignalingNotify {
   // MARK: イベント情報
@@ -692,6 +707,8 @@ extension Signaling: Codable {
       self = try .switched(SignalingSwitched(from: decoder))
     case "redirect":
       self = try .redirect(SignalingRedirect(from: decoder))
+    case "close":
+      self = try .close(SignalingClose(from: decoder))
     default:
       throw SoraError.unknownSignalingMessageType(type: type)
     }
@@ -1355,3 +1372,17 @@ extension SignalingRedirect: Decodable {
     location = try container.decode(String.self, forKey: .location)
   }
 }
+
+/// :nodoc:
+extension SignalingClose: Decodable {
+  enum CodingKeys: String, CodingKey {
+    case code
+    case reason
+  }
+
+  public init(from decoder: Decoder) throws {
+    let container = try decoder.container(keyedBy: CodingKeys.self)
+    code = try container.decode(Int.self, forKey: .code)
+    reason = try container.decode(String.self, forKey: .reason)
+  }
+}