SoraCloseEvent

public enum SoraCloseEvent

SoraCloseEvent は、Sora の接続が切断された際のイベント情報を表します。

接続が正常に切断された場合は、.ok(code, reason) ケースが使用され、 異常な切断やエラー発生時は、.error(Error) ケースが使用されます。

  • 正常な接続切断を示します。

    Declaration

    Swift

    case ok(code: Int, reason: String)

    Parameters

    code

    接続切断時に返されるコード。例えば、WebSocket の標準切断コード(例: 1000 等)など。

    reason

    接続が正常に切断された理由の説明文字列。

  • 異常な切断またはエラーが発生して切断した場合に利用されるケースです。

    Declaration

    Swift

    case error(Error)

    Parameters

    error

    エラー情報。