基本
- 通信は UDP です。1 つのデータグラムに 1 つのメッセージを入れ、大きさは 1,200 バイト以下です。
- メッセージの形式は **FIX SBE(Simple Binary Encoding)**で、バイト順はリトルエンディアンです(メッセージの形式)。
- 制御(認証、購読、Heartbeat)と配信(
Ticks)は、同じポートを使います。Tick サーバーは、クライアントが送ってきた送信元(IP アドレスとポート)にティックを送ります。 - 1 つの UDP ソケットで、認証から受信までを行ってください。 送信元のポートが変わると、Tick サーバーは別の購読者として扱います。
- Tick サーバーから届くデータは暗号化されていません。
手順
クライアントTick サーバー
認証
- 1Hello認証を始める
認証を始める
- 2Challengecookie(16 バイト)
cookie(16 バイト)
- 3Authenticatecookie を nonce に入れ、APIキーで署名した JWT
cookie を nonce に入れ、APIキーで署名した JWT
- 4AuthenticateAck購読者トークン
購読者トークン
購読
- 5Subscribeシンボル名の一覧
シンボル名の一覧
- 6SubscribeAckシンボルごとのシンボル ID
シンボルごとのシンボル ID
受信
- 7Ticksティックが届くたびに送られる
ティックが届くたびに送られる
- 8Heartbeat1 秒ごと
1 秒ごと
- 9HeartbeatAck購読が続いているか
購読が続いているか
Helloを送ります。Tick サーバーはChallengeで cookie(16 バイト)を返します。cookie は 20〜30 秒ほどの間、Helloを送ったのと同じ送信元からだけ使えます。- APIキーの秘密鍵で JWT を作り、
Authenticateで送ります。JWT のnonceには、cookie を URL セーフ Base64(パディングなし)にした文字列を入れます(認証(JWT))。 AuthenticateAckの結果がAcceptedなら、購読者トークン(16 バイト)を受け取ります。以降のSubscribeとHeartbeatには、このトークンを載せます。Subscribeで、受け取りたいシンボルの名前を送ります。SubscribeAckで、シンボルごとのシンボル ID が返ります。Ticksにはシンボル名ではなくシンボル ID が入っています。- 購読が成立すると、次のティックから
Ticksが届き始めます。購読した時点の最新値は送られないので、動きの少ないシンボルは次のティックまで値がわかりません。 Heartbeatを 1 秒ごとに送ってください。5 秒途絶えると、Tick サーバーは購読を終わらせます。HeartbeatAckのsubscribedが 0 になったら、購読は終わっています(理由はendReason)。Helloからやり直してください。
応答が届かないとき
UDP なので、要求も応答も失われることがあります。応答が届かないときは、0.5〜1 秒ほど待ってから同じ手順を送り直してください。
SubscribeとAuthenticateは、送り直しても問題ありません。同じ送信元から同じ APIキーで認証し直すと、同じ購読者トークンが返ります。AuthenticateがInvalidCookieで拒否されたら、cookie の期限が切れています。Helloからやり直してください。- 応答には、要求の
requestIdがそのまま入っています。送り直した要求と応答の対応を取るのに使えます。
購読を変える・やめる
Subscribeは、購読を送ったシンボルの集合で置き換えます(足すのではありません)。シンボルを足すときは、今のシンボルも含めて送ってください。- 1 回の
Subscribeで送れるシンボルは 64 個までです。 - 空の集合を送ると、購読者が終わります。 IP アドレスの枠もすぐに空きます。もう一度受け取るには、
Helloからやり直してください。
要求の回数の制限
Tick サーバーは、送信元の IP アドレスごとに要求の回数を制限しています。Hello と Authenticate は、それぞれ毎秒 10 回までです。超えた要求には、拒否の応答(RateLimited)が返るか、何も返りません。短い間隔で送り続けないでください。
購読が終わる理由
購読は、次のときに終わります。理由は HeartbeatAck の endReason でわかります(結果と終了理由)。
Heartbeatが 5 秒途絶えた- 空の
Subscribeを送った - APIキーを再発行した、または契約の期間が終わった
- 同じ送信元から、別の APIキーで認証し直した
- Tick サーバーが再起動した
どの場合も、理由が解消していれば Hello からやり直すと、また受け取れます。