API / イベントリファレンス
API / イベントリファレンス
Section titled “API / イベントリファレンス”このページでは、AdderのイベントAPIとGo APIのシャットダウン契約を説明します。
/events の replay パラメーター
Section titled “/events の replay パラメーター”/events は、バッファー済みイベントの再送を制御する省略可能な replay クエリパラメーターを受け付けます。
/events?replay=truereplayを省略した場合、replay=trueとして扱います。バッファー済みイベントを再送します。replay=falseを指定すると、ライブイベントだけを配信し、バッファー済みイベントを再送しません。replay=trueを指定すると、バッファー済みイベントを再送します。
組み込みトレイでは、初回接続に replay=false を使用し、再接続に replay=true を使用します。この接続方針は組み込みトレイの動作であり、すべてのAPIクライアントに対する要件ではありません。
Go API のシャットダウン契約
Section titled “Go API のシャットダウン契約”api.API を実装するコードは、次のメソッドを提供する必要があります。
Shutdown(context.Context) errorAPIv1 はリスナーのシャットダウンを実装します。api.API を呼び出すコードは、Shutdown(context.Context) error とそのエラーを処理する必要があります。
Docs authored by Doc Holiday