X API SDK 向けの堅牢なストリーミングユーティリティ。
このモジュールは、自動再接続、指数バックオフ、包括的なエラーハンドリングを備えたストリーミング接続の管理機能を提供します。Client は接続管理を気にせずにストリーミングエンドポイントを利用でき、復旧はすべて SDK が自動的に処理します。
class xdk.streaming.StreamConfig
リトライ動作を伴うストリーミング接続の設定。
パラメータ
path.timeout float or None
デフォルト: "None"
path.on_connect Callable[[], None] or None
デフォルト: "None"
path.on_disconnect Callable[[Exception or None], None] or None
デフォルト: "None"
path.on_reconnect Callable[[int, float], None] or None
デフォルト: "None"
パラメータ
path.timeout float or None
デフォルト: "None"
path.on_connect Callable[[], None] or None
デフォルト: "None"
path.on_disconnect Callable[[Exception or None], None] or None
デフォルト: "None"
path.on_reconnect Callable[[int, float], None] or None
デフォルト: "None"
on_error : Callable[[[StreamError]
exception xdk.streaming.StreamError
分類情報を伴うストリーミングエラーが発生したときに送出される例外です。
パラメータ
パラメータ
class xdk.streaming.StreamErrorType
再試行判断に用いるストリーミングエラーの分類。
パラメータ
class xdk.streaming.StreamState
ストリーミング接続の内部状態を表します。
path.total_items_received
パラメータ
path.total_items_received
last_error : [StreamError]
xdk.streaming.stream_with_retry
自動再接続と指数バックオフを用いて、エンドポイントからデータをストリーミングします。
この関数は、以下を含むすべての接続管理を行います:
切断時の自動再接続
リトライ待機時間に対するジッター付き指数バックオフ
エラーを再試行可能なものと致命的なものに分類
接続状態を監視するためのライフサイクルコールバック
HTTP 呼び出しに使用する requests の Session オブジェクト。
リトライおよびコールバック設定を含む StreamConfig。