モード機能¶

ノーマルモード¶

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

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

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

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

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

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

イニシャルモード¶

このモードはすべての接続をブロックします。

• クラスターへ参加したタイミングでノーマルモードで自動で切り替わります
• クラスターから孤立したタイミングでノーマルモードからイニシャルモードへ自動で切り替わります
  • ノーマルモード以外の場合には、切り替わらずに、その時のモードが維持されます

このモードを指定して変更することはできません。

session.vanished¶

このウェブフックは、新規コネクションブロック、または新規セッションブロックモード時に全てのセッションが破棄されたタイミングで送信されます。

{
     "type": "session.vanished",
}

ChangeMode¶

• mode
  • normal
  • block_new_session
  • block_new_connection

$ http POST 127.0.0.1:3000 x-sora-target:Sora_20211215.ChangeMode mode=block_new_session -vvv
POST / HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 29
Content-Type: application/json
Host: 127.0.0.1:3000
User-Agent: HTTPie/2.3.0
x-sora-target: Sora_20211215.ChangeMode

{
    "mode": "block_new_session"
}


HTTP/1.1 200 OK
access-control-allow-headers: Origin, X-Requested-With, Content-Type, Accept, x-sora-target
access-control-allow-methods: POST, OPTIONS
access-control-allow-origin: http://127.0.0.1:5000
access-control-max-age: 1000
content-length: 28
content-type: application/json
date: Wed, 06 Oct 2021 10:42:35 GMT
server: Cowboy

{
    "mode": "block_new_session"
}

$ http POST 127.0.0.1:3000 x-sora-target:Sora_20211215.ChangeMode mode=block_new_connection -vvv
POST / HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 32
Content-Type: application/json
Host: 127.0.0.1:3000
User-Agent: HTTPie/2.3.0
x-sora-target: Sora_20211215.ChangeMode

{
    "mode": "block_new_connection"
}


HTTP/1.1 200 OK
access-control-allow-headers: Origin, X-Requested-With, Content-Type, Accept, x-sora-target
access-control-allow-methods: POST, OPTIONS
access-control-allow-origin: http://127.0.0.1:5000
access-control-max-age: 1000
content-length: 31
content-type: application/json
date: Wed, 06 Oct 2021 10:44:05 GMT
server: Cowboy

{
    "mode": "block_new_connection"
}

GetMode¶

$ http POST 127.0.0.1:3000 x-sora-target:Sora_20211215.GetMode -vvv
POST / HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 0
Host: 127.0.0.1:3000
User-Agent: HTTPie/2.3.0
x-sora-target: Sora_20211215.GetMode



HTTP/1.1 200 OK
access-control-allow-headers: Origin, X-Requested-With, Content-Type, Accept, x-sora-target
access-control-allow-methods: POST, OPTIONS
access-control-allow-origin: http://127.0.0.1:5000
access-control-max-age: 1000
content-length: 17
content-type: application/json
date: Wed, 06 Oct 2021 10:42:19 GMT
server: Cowboy

{
    "mode": "normal"
}

クラスター機能有効での Sora 起動時の mode¶

クラスター機能を利用した場合、 Sora 起動時の mode が イニシャルモード になります。

クラスターへの参加に成功したタイミングで イニシャルモード から ノーマルモード へ変更されます。

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

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

block_new_connection¶

block_new_session¶