モード機能¶

概要¶

モード機能は、指定されているモードごとに Sora の挙動を変更する機能です。

目的¶

Sora 自体は認証の機能を持っていないため、メンテナンス時に一時的に接続をブロックするといった仕組みがありません。接続をブロックする場合は、認証サーバー側で処理をすることになり不便でした。

そこで、Sora 側にモード機能を持たせることで、モードを切り替えることで接続を気軽にブロックできる機能を追加します。

モード¶

ノーマルモード¶

このモードは何もせず、すべての新規接続を受け入れます。

新規コネクションブロックモード¶

このモードは新規の接続をブロックします。すでに接続しているコネクションはそのままです。

新規セッションブロックモード¶

このモードは新規セッションの作成をブロックします。すでに接続しているセッションやコネクションはそのままです。

そのためセッション(チャネルに 1 人以上接続しているアクティブな状態)が存在する場合は接続できますが、セッションが存在しない場合は新規の接続をブロックします。

API¶

ChangeMode API¶

モード変更 API です。指定するモードには 3 種類あります。

normal
block_new_session
block_new_connection

$ curl -sS \
    -X POST \
    http://127.0.0.1:3000 \
    -H "x-sora-target: Sora_20211215.ChangeMode" \
    --json '{"mode":"block_new_session"}' \
    | jq .
{
    "mode": "block_new_session"
}

$ curl -sS \
    -X POST \
    http://127.0.0.1:3000 \
    -H "x-sora-target: Sora_20211215.ChangeMode" \
    --json '{"mode":"block_new_connection"}' \
    | jq .
{
    "mode": "block_new_connection"
}

詳細は ChangeMode をご確認ください。

GetMode API¶

モード取得 API です。

$ curl -sS \
    -X POST \
    http://127.0.0.1:3000 \
    -H "x-sora-target: Sora_20211215.GetMode" \
    | jq .
{
    "mode": "normal"
}

詳細は GetMode をご確認ください。

クラスター機能¶

チャネル ID のノード割り当て¶

クラスター機能を利用した場合、 mode が新規セッションブロックモードまたは新規コネクションブロックモードのノードに対して、新規のチャネル ID を割り当てません。