iSCP - リアルタイムAPI¶
リアルタイム通信用エンドポイントへのアクセスAPIを提供します。
Main API¶
- class Conn(...)[ソース]¶
iSCPのコネクションを表すクラスです。
注意
このクラスのオブジェクトは、必ず Conn の connect() を使用して生成してください。
async with await Conn.connect(...) as conn: pass
このコードは以下のコードと等価です。
conn = await Conn.connect(...) try: pass finally: await conn.close()
- async calls(*, timeout=None)[ソース]¶
E2Eコールを受信します。
- パラメータ
timeout (Optional[float]) -- 読み込みタイムアウト(秒)。指定しない場合はタイムアウトしません。
- 列挙
iscp.DownstreamCall -- ダウンストリームコール
サンプル
>>> async for call in conn.calls(): pass
- async classmethod connect(address, connector, *, encoding=EncodingName.PROTOBUF, node_id=None, ping_interval=10.0, ping_timeout=1.0, project_uuid=None, token_source=None, disconnected_event_handler=None)[ソース]¶
iSCPブローカーに接続します。
- パラメータ
address (str) -- 接続先のアドレス。127.0.0.1:8080 形式。
connector (iscp.Connector) -- トランスポートのコネクターです。
encoding (iscp.EncodingName|str) -- エンコーディング名
node_id (Optional[str]) -- ノードID
ping_interval (float) -- Ping間隔(秒)
ping_timeout (float) -- Pingタイムアウト(秒)。タイムアウトが発生した場合トランスポートを切断します。
project_uuid (Optional[UUID | str]) -- プロジェクトUUID
token_source (Optional[iscp.TokenSource]) -- トークンソース。iSCPコネクションを開くたびに、このメソッドをコールしトークンを取得します。
disconnected_event_handler (Optional[iscp.DisconnectedEventHandler]) -- 切断イベントのハンドラ
- 戻り値
iSCPコネクション
- 戻り値の型
- async open_downstream(filters, *, data_ids=None, qos=QoS.UNRELIABLE, expiry_interval=1, ack_interval=1, closed_event_handler=None)[ソース]¶
ダウンストリームを開きます。
- パラメータ
filters (List[iscp.DownstreamFilter]) -- ダウンストリームフィルタのリスト
data_ids (Optional[List[iscp.DataID]]) -- データIDのリスト
qos (iscp.QoS|str) -- QoS
expiry_interval (float) -- 有効期限(秒)
ack_interval (float) -- Ack返却間隔(秒)
closed_event_handler (Optional[iscp.DownstreamClosedEventHandler]) -- ダウンストリームクローズイベントのハンドラ
- 戻り値
ダウンストリーム
- 戻り値の型
- async open_upstream(session_id, *, expiry_interval=1, data_ids=None, qos=QoS.UNRELIABLE, ack_interval=1, persist=False, send_data_points_callback=None, receive_ack_callback=None, flush_policy=<iscp._flush_policy.IntervalOrBufferSize object>, close_timeout=1, closed_event_handler=None, close_session=False)[ソース]¶
アップストリームを開きます。
- パラメータ
session_id (str) -- セッションID
expiry_interval (float) -- 有効期限(秒)
data_ids (Optional[List[iscp.DataID]]) -- データIDのリスト
qos (iscp.QoS|str) -- QoS
ack_interval (float) -- Ack返却間隔(秒)
persist (bool) -- 永続化するかどうか
send_data_points_callback (Optional[iscp.BeforeSendDataPointsCallback]) -- データポイント送信時のフック
receive_ack_callback (Optional[iscp.AfterReceiveAckCallback]) -- Ack受信時のフック
flush_policy (iscp.FlushPolicy) -- データポイントのフラッシュポリシー
close_timeout (float) -- クローズのタイムアウト(秒)
closed_event_handler (Optional[iscp.UpstreamClosedEventHandler]) -- アップストリームクローズイベントのハンドラ
close_session (bool) -- アップストリームクローズ時にセッションをクローズするかどうか
- async reply_calls(*, timeout=None)[ソース]¶
E2Eリプライコールを受信します。
- パラメータ
timeout (Optional[float]) -- 読み込みタイムアウト(秒)。指定しない場合はタイムアウトしません。
- 列挙
iscp.DownstreamReplyCall -- ダウンストリームリプライコール
サンプル
>>> async for call in conn.reply_calls(): pass
- async send_base_time(base_time, *, persist=False)[ソース]¶
基準時刻を送信します。
- パラメータ
base_time (iscp.BaseTime) -- 基準時刻
persist (bool) -- 永続化するかどうか
- async send_call(upstream_call)[ソース]¶
E2Eコールを送信します。
- パラメータ
upstream_call (iscp.UpstreamCall) -- アップストリームコール
- 戻り値
コールID
- 戻り値の型
str
- async send_call_and_wait_reply_call(upstream_call)[ソース]¶
E2Eコールを送信し、リプライコールを受信するまで待ちます。
- パラメータ
upstream_call (iscp.UpstreamCall) -- アップストリームコール
- 戻り値
ダウンストリームリプライコール
- 戻り値の型
- async send_metadata(metadata, *, persist=False)[ソース]¶
メタデータを送信します。
- パラメータ
base_time (iscp.SendableMetadata) -- メタデータ
persist (bool) -- 永続化するかどうか
- async send_reply_call(reply_call)[ソース]¶
E2Eコールのリプライを送信します。
- パラメータ
reply_call (iscp.UpstreamReplyCall) -- アップストリームリプライコール
- 戻り値
コールID
- 戻り値の型
str
- property address¶
アドレスを取得します。
- 戻り値
アドレス
- 戻り値の型
str
- property encoding¶
エンコーディング名を取得します。
- 戻り値
エンコーディング名
- 戻り値の型
- property node_id¶
ノードIDを取得します。
- 戻り値
ノードID
- 戻り値の型
Optional[str]
- property ping_interval¶
Ping間隔(秒)を取得します。
- 戻り値
Ping間隔(秒)
- 戻り値の型
float
- property ping_timeout¶
Pingタイムアウト(秒)を取得します。
- 戻り値
Pingタイムアウト(秒)
- 戻り値の型
float
- property project_uuid¶
プロジェクトUUIDを取得します。
- 戻り値
プロジェクトUUID
- 戻り値の型
Optional[UUID]
- property transport¶
トランスポート名を取得します。
- 戻り値
トランスポート名
- 戻り値の型
- class Downstream(...)[ソース]¶
ダウンストリームを表すクラスです。
注意
このクラスのオブジェクトは、必ず iscp.Conn の open_downstream() を使用して生成してください。
async with await Conn.connect(...) as conn: async with await conn.open_downstream(...) as downstream: pass
このコードは以下のコードと等価です。
async with await Conn.connect(...) as conn: downstream = await conn.open_downstream(...) try: pass finally: await downstream.close()
- async chunks(*, timeout=None)[ソース]¶
ダウンストリームチャンクを受信します。
- パラメータ
timeout (Optional[float]) -- 読み込みタイムアウト(秒)。指定しない場合はタイムアウトしません。
- 列挙
iscp.DownstreamChunk -- ダウンストリームチャンク
サンプル
>>> with conn.open_downstream(...) as downstream: async for msg in downstream.chunks(): print(msg)
- async metadatas(*, timeout=None)[ソース]¶
タイムアウトを指定して、ダウンストリームメタデータを受信します。
- パラメータ
timeout (Optional[float]) -- 読み込みタイムアウト(秒)。指定しない場合はタイムアウトしません。
- 列挙
iscp.DownstreamMetadata -- ダウンストリームメタデータ
サンプル
>>> with conn.open_downstream(...) as downstream: async for msg in downstream.metadatas(): print(msg)
- property ack_interval¶
Ack返却間隔(秒)を取得します。
- 戻り値
Ack返却間隔(秒)
- 戻り値の型
float
- property expiry_interval¶
有効期限を取得します。
- 戻り値
ストリームの有効期限(秒)
- 戻り値の型
float
- property filters¶
ダウンストリームフィルターを取得します。
- 戻り値
ダウンストリームフィルターのリスト
- 戻り値の型
List[iscp.DownstreamFilter]
- property id¶
ストリームIDを取得します。
- 戻り値
ストリームID
- 戻り値の型
UUID
- property server_time¶
DownstreamResponseで返却されたサーバー時刻を取得します。
- 戻り値
DownstreamResponseで返却されたサーバー時刻
- 戻り値の型
- property state¶
ストリームの状態を取得します。
- 戻り値
ダウンストリームの状態
- 戻り値の型
- class Upstream(...)[ソース]¶
アップストリームを表すクラスです。
注意
このクラスのオブジェクトは、必ず iscp.Conn の open_upstream() を使用して生成してください。
async with await Conn.connect(...) as conn: async with await conn.open_upstream(...) as upstream: pass
このコードは以下のコードと等価です。
async with await Conn.connect(...) as conn: upstream = await conn.open_upstream(...) try: pass finally: await upstream.close()
- async close(overwrite_close_session=None)[ソース]¶
TODO: Document アップストリームを閉じます。
- パラメータ
overwrite_close_session (Optional[bool]) -- アップストリームに設定されている close_session を上書きします。
- async write_data_point(data_id, *data_points)[ソース]¶
データポイントを送信します。
- パラメータ
data_id (iscp.DataID) -- データID
*data_points (iscp.DataPoint) -- データポイント
- property ack_interval¶
Ackの返却間隔を取得します。
- 戻り値
Ackの返却間隔(秒)
- 戻り値の型
float
- property close_session¶
Document クローズ時にセッションをクローズするかどうかを取得します。
- 戻り値
クローズ時にセッションをクローズするかどうか
- 戻り値の型
bool
- Type
TODO
- property close_timeout¶
クローズタイムアウト(秒)を取得します。
- 戻り値
クローズタイムアウト(秒)
- 戻り値の型
float
- property expiry_interval¶
有効期限を取得します。
- 戻り値
ストリームの有効期限(秒)
- 戻り値の型
float
- property flush_policy¶
フラッシュポリシーを取得します。
- 戻り値
フラッシュポリシー
- 戻り値の型
- property id¶
ストリームIDを取得します。
- 戻り値
ストリームID
- 戻り値の型
UUID
- property persist¶
永続化フラグを取得します。
- 戻り値
永続化フラグ
- 戻り値の型
Bool
- property server_time¶
UpstreamResponseで返却されたサーバー時刻を取得します。
- 戻り値
UpstreamResponseで返却されたサーバー時刻
- 戻り値の型
- property session_id¶
セッションIDを取得します。
- 戻り値
セッションID
- 戻り値の型
str
- property state¶
ストリームの状態を取得します。
- 戻り値
アップストリームの状態
- 戻り値の型
Connectors¶
- class Connector(...)[ソース]¶
iSCPコネクターのインターフェースです。
- abstract async connect(address, negotiation_params)[ソース]¶
iSCPを使って接続します。
- パラメータ
address (str) -- 接続先のアドレス。127.0.0.1:8080 形式。
negotiation_params (iscp.NegotiationParams) -- ネゴシエーションパラメータ
- 戻り値
iSCPのトランスポート
- 戻り値の型
- class WebSocketConnector(...)[ソース]¶
WebSocketのiSCPコネクターです。
- パラメータ
enable_tls (bool) -- TLS有効化フラグ。Trueの場合は
wss://${address}/${path},Falseの場合はws://${address}/${path}でアクセスを試みます。path (str) -- 接続先のaddressに続くパス
- async connect(address, negotiation_params)[ソース]¶
iSCPを使って接続します。
- パラメータ
address (str) -- 接続先のアドレス。127.0.0.1:8080 形式。
negotiation_params (iscp.NegotiationParams) -- ネゴシエーションパラメータ
- 戻り値
iSCPのトランスポート
- 戻り値の型
- class QuicConnector(...)[ソース]¶
QUICのiSCPコネクターです。
- パラメータ
insecure (bool) -- Trueの場合、SSL証明書の検証を行いません。
- async connect(address, negotiation_params=NegotiationParams(enc=<EncodingName.PROTOBUF: 'proto'>))[ソース]¶
iSCPを使って接続します。
- パラメータ
address (str) -- 接続先のアドレス。127.0.0.1:8080 形式。
negotiation_params (iscp.NegotiationParams) -- ネゴシエーションパラメータ
- 戻り値
iSCPのトランスポート
- 戻り値の型
Callbacks¶
- BeforeSendDataPointsCallback¶
Callable[[UUID,UpstreamChunk],None]の別名です。
- AfterReceiveAckCallback¶
Callable[[UUID,UpstreamChunkAck],None]の別名です。
Event Handlers¶
- DisconnectedEventHandler¶
Callable[[DisconnectedEvent],None]の別名です。
- DownstreamClosedEventHandler¶
Callable[[DownstreamClosedEvent],None]の別名です。
- UpstreamClosedEventHandler¶
Callable[[UpstreamClosedEvent],None]の別名です。
Messages¶
Upstream¶
- class UpstreamChunk(...)[ソース]¶
ストリームチャンク(上り用)です。
- stream_id_alias¶
ストリームIDエイリアス
- Type
int
- data_ids¶
データIDのリスト
- Type
List[iscp.DataID]
- stream_chunk¶
ストリームチャンク
- Type
- extension_fields¶
拡張フィールド
- class UpstreamChunkResult(...)[ソース]¶
ストリームチャンク(上り用)で送信されたデータポイントの処理結果です。
- sequence_number¶
シーケンス番号
- Type
int
- result_code¶
結果コード
- Type
- result_string¶
結果文字列
- Type
str
- extension_fields¶
拡張フィールド
- class UpstreamChunkAck(...)[ソース]¶
ストリームチャンク(上り用)に対する確認応答です。
- stream_id_alias¶
ストリームIDエイリアス
- Type
int
- results¶
処理結果のリスト
- Type
List[iscp.UpstreamChunkResult]
- data_id_aliases¶
データIDエイリアス
- Type
Dict[int, iscp.DataID]
- extension_fields¶
拡張フィールド
Downstream¶
- class DownstreamChunk(...)[ソース]¶
ダウンストリームチャンクを表します。
- upstream_info¶
アップストリーム情報
- Type
- sequence_number¶
シーケンス番号
- Type
int
- data_point_groups¶
データポイントのリスト
- Type
List[iscp.DataPointGroup]
- class DownstreamMetadata(...)[ソース]¶
ダウンストリームメタデータを表します。
- source_node_id¶
送信元ノードID
- Type
str
- metadata¶
メタデータ
- Type
iscp.Metadata
- class DownstreamFilter(...)[ソース]¶
ダウンストリームフィルタを表します。
- source_node_id¶
送信元ノードID
- Type
str
- data_filters¶
データフィルタのリスト
- Type
List[iscp.DataFilter]
- class DataFilter(...)[ソース]¶
受信するデータを指定するためのデータフィルタです。
名称や型の指定において階層構造を表現したいときには、特殊文字
/をセパレータとして使用することができます。特殊文字
#はマルチレベルワイルドカードです。フィルタが
#のとき、nameはマッチします。フィルタが
#のとき、group/nameはマッチします。フィルタが
group/#のとき、group/nameはマッチします。フィルタが
group/#のとき、group/sub-group/nameはマッチします。フィルタが
group/#のとき、other-group/nameはマッチしません。
特殊文字
+は単一レベルワイルドカードです。フィルタが
+のとき、nameはマッチします。フィルタが
group/+のとき、group/nameはマッチします。フィルタが
group/+/nameのとき、group/sub-group/nameはマッチします。フィルタが
group/+/nameのとき、group/other-group/nameはマッチします。フィルタが
group/+/nameのとき、group/other-group/some-nameはマッチしません。
- name¶
名称
- Type
str
- type¶
型
- Type
str
E2E¶
- class UpstreamCall(...)[ソース]¶
アップストリームコールを表します。
- destination_node_id¶
宛先ノードID
- Type
str
- name¶
名称
- Type
str
- type¶
型
- Type
str
- payload¶
ペイロード
- Type
bytes
- class DownstreamCall(...)[ソース]¶
ダウンストリームコールを表します。
- call_id¶
コールID
- Type
str
- source_node_id¶
送信元ノードID
- Type
str
- name¶
名称
- Type
str
- type¶
型
- Type
str
- payload¶
ペイロード
- Type
bytes
Models¶
Metadata¶
- Metadata¶
Union[BaseTime,UpstreamOpen,UpstreamAbnormalClose,UpstreamResume,UpstreamNormalClose,DownstreamOpen,DownstreamAbnormalClose,DownstreamResume,DownstreamNormalClose]の別名です。
- class BaseTime(...)[ソース]¶
基準時刻です。
- session_id¶
セッションID
- Type
str
- name¶
名前
- Type
str
- priority¶
優先度
- Type
int
- elapsed_time¶
経過時間(ナノ秒)
- Type
int
- base_time¶
時刻
- Type
- class UpstreamOpen(...)[ソース]¶
あるアップストリームが開いたことを知らせるメタデータです。
- stream_id¶
ストリームID
- Type
UUID
- session_id¶
セッションID
- Type
str
- class UpstreamNormalClose(...)[ソース]¶
あるアップストリームが正常切断したことを知らせるメタデータです。
- stream_id¶
ストリームID
- Type
UUID
- session_id¶
セッションID
- Type
str
- total_data_points¶
総データポイント数
- Type
int
- final_sequence_number¶
最終シーケンス番号
- Type
int
- class UpstreamAbnormalClose(...)[ソース]¶
あるアップストリームが異常切断したことを知らせるメタデータです。
- stream_id¶
ストリームID
- Type
UUID
- session_id¶
セッションID
- Type
str
- class UpstreamResume(...)[ソース]¶
あるアップストリームが再開したことを知らせるメタデータです。
- stream_id¶
ストリームID
- Type
UUID
- session_id¶
セッションID
- Type
str
- class DownstreamOpen(...)[ソース]¶
あるダウンストリームが開いたことを知らせるメタデータです。
- stream_id¶
ストリームID
- Type
UUID
- downstream_filters¶
ダウンストリームフィルター
- Type
List[DownstreamFilter]
- class DownstreamNormalClose(...)[ソース]¶
あるダウンストリームが正常切断したことを知らせるメタデータです。
- stream_id¶
ストリームID
- Type
UUID
Others¶
- class UpstreamState(...)[ソース]¶
アップストリームの状態を表します。
- data_id_aliases¶
データIDとエイリアスのマップ
- Type
Dict[int, iscp.DataID]
- total_data_points¶
総送信データポイント数
- Type
int
- last_issued_sequence_number¶
最後に払い出されたシーケンス番号
- Type
int
- data_points_buffer¶
内部に保存しているデータポイントバッファ
- Type
list[_model.DataPointGroup]
- class DownstreamState(...)[ソース]¶
ダウンストリームの状態を表します。
- id¶
ストリームID
- Type
UUID
- data_id_aliases¶
データIDエイリアスとデータIDのマップ
- Type
Dict[int, iscp.DataID]
- last_issued_data_id_alias¶
最後に払い出されたデータIDエイリアス
- Type
int
- upstream_infos¶
アップストリームエイリアスとアップストリーム情報のマップ
- Type
Dict[int, iscp.UpstreamInfo]
- last_issued_upstream_info_alias¶
最後に払い出されたアップストリーム情報のエイリアス
- Type
int
- last_issued_ack_sequence_number¶
最後に払い出されたAckのシーケンス番号
- Type
int
- server_time¶
DownstreamOpenResponseで返却されたサーバー時刻
- Type
- class DataPointGroup(...)[ソース]¶
データID付きのデータポイントを表します。
- data_id¶
データID
- Type
- data_points¶
データポイント配列
- Type
List[iscp.DataPoint]
- class DataID(...)[ソース]¶
DataIDは、データポイントの、名称とデータ型を表す識別子です。
おもに、ブローカーおよびノードでのデータの意味と型の特定、 ダウンストリームフィルタにて指定された受信条件に各時系列データポイントが合致するかどうかの判定、などに使用されます。
特殊文字
/はセパレータです。名称や型の階層構造を表現することができます。- name¶
名称
- Type
str
- type¶
型
- Type
type
- class DataPoint(...)[ソース]¶
データポイントを表します。
データポイントは、経過時間を付与されたバイナリデータです。 バイナリデータのことをペイロードと呼びます。
- elapsed_time¶
経過時間ナノ秒
- Type
int
- payload¶
ペイロード
- Type
bytes
- class StreamChunk(...)[ソース]¶
ストリームを時間で区切ったデータポイントのまとまりです。
iSCP におけるデータ伝送は、このチャンク単位で行われます。
- sequence_number¶
シーケンス番号
- Type
int
- data_point_groups¶
データポイントグループのリスト
- Type
List[iscp.DataPointGroup]
- class QoS(...)[ソース]¶
QoSを表します。
- PARTIAL = 'PARTIAL'¶
PARTIAL
- RELIABLE = 'RELIABLE'¶
RELIABLE
- UNRELIABLE = 'UNRELIABLE'¶
UNRELIABLE
- class TransportName(...)[ソース]¶
トランスポートのの名前です。
- QUIC = 'quic'¶
QUIC
- WEBSOCKET = 'websocket'¶
WebSocket
- TokenSource¶
Callable[[],str]の別名です。
- class DateTime(...)[ソース]¶
iSCPで使用する日時を表します。
- datetime¶
日時(マイクロ秒精度)
- Type
datetime
- nano_secs¶
ナノ秒部
- Type
int
- class ResultCode(...)[ソース]¶
ResultCode は、要求の処理結果を表す識別コードです。
ResultCode は、以下の値を取ります。
- ACK_TIMEOUT = 70¶
ACKの返却までに時間がかかりすぎて、送信側よりネットワークが切断されたことを表します。
- AUTH_FAILED = 66¶
認証や認可の処理に失敗したことを表します。
- CONNECT_TIMEOUT = 67¶
妥当な時間までに、通信の開始シーケンスが完了しなかったことを表します。
- DESIRED_QOS_NOT_SUPPORTED = 78¶
要求されたQoSをサポートしていないことを表します。
- INCOMPATIBLE_VERSION = 1¶
ノードとブローカーのバージョンに互換性が無いことを表します。
- INVALID_DATA_FILTER = 74¶
データフィルタが不正であることを表します。
- INVALID_DATA_ID = 72¶
データIDが不正であることを表します。
- INVALID_DATA_ID_ALIAS = 73¶
データIDエイリアスが不正であることを表します。
- INVALID_PAYLOAD = 71¶
ペイロードの形式が不正であることを表します。
- MALFORMED_MESSAGE = 68¶
不正な形式のメッセージを受信したことを表します。
- MAXIMUM_DATA_ID_ALIAS = 2¶
データIDエイリアス値の数が上限に達し、データIDエイリアス値を新たに割り当てることができないことを表します。
- MAXIMUM_UPSTREAM_ALIAS = 3¶
アップストリームエイリアス値の数が上限に達し、アップストリームエイリアス値を新たに割り当てることができないことを表します。
- NODE_ID_MISMATCH = 128¶
レートリミットに到達したことを表します。
- NORMAL_CLOSURE = 0¶
正常にコネクションが閉じられたことを表します。
- NO_NODE_ID = 65¶
接続時にノードIDを指定していないことを表します。
- PING_TIMEOUT = 79¶
Pingのタイムアウトが発生したことを表します。
- PROCESS_FAILED = 77¶
処理が失敗したことを表します。
- PROTOCOL_ERROR = 69¶
プロトコル違反を表します。
- RATE_LIMIT_REACHED = 90¶
すでに永続化されているセッションの生成元ノードと、新たに永続化しようとするノードが異なることを表します。
- RESUME_REQUEST_CONFLICT = 76¶
再開しようとしたストリームが接続中であることを表します。
- SESSION_ALREADY_CLOSED = 130¶
セッションがすでに閉じられていることを表します。
- SESSION_CANNOT_CLOSED = 131¶
セッションを閉じることができないことを表します。
- SESSION_NOT_FOUND = 129¶
セッションが見つからなかったことを表します。
- STREAM_NOT_FOUND = 75¶
受信者が保持している情報の中に、対象のストリームが含まれないことを表します。
- SUCCEEDED = 0¶
処理が正常に成功したことを表します。
- TOO_LARGE_MESSAGE_SIZE = 80¶
メッセージのサイズが大きすぎることを表します。
- TOO_LONG_ACK_INTERVAL = 83¶
ACKの返却間隔が長すぎることを表します。
- TOO_LONG_EXPIRY_INTERVAL = 86¶
有効期限が長すぎることを表します。
- TOO_LONG_PING_TIMEOUT = 87¶
Pingタイムアウト値が大きすぎることを表します。
- TOO_MANY_DATA_FILTERS = 85¶
データフィルタが多すぎることを表します。
- TOO_MANY_DATA_ID_ALIASES = 81¶
データIDエイリアスが多すぎることを表します。
- TOO_MANY_DOWNSTREAM_FILTERS = 84¶
ダウンストリームフィルタが多すぎることを表します。
- TOO_MANY_STREAMS = 82¶
ストリームが多すぎることを表します。
- TOO_SHORT_PING_INTERVAL = 88¶
Ping間隔が短すぎることを表します。
- TOO_SHORT_PING_TIMEOUT = 89¶
Pingタイムアウトが短すぎることを表します。
- UNSPECIFIED_ERROR = 64¶
種類を規定しないエラーです。予期しないエラーが発生した場合に使用されます。
- class FlushPolicy(...)[ソース]¶
Upstreamのフラッシュの方法について定義します。
- class Immediately(...)[ソース]¶
即時フラッシュを行うFlushPolicyです。
- class IntervalOnly(...)[ソース]¶
インターバルによるフラッシュを行うFlushPolicyです。
- interval¶
フラッシュインターバル(秒)
- Type
float
- class BufferSizeOnly(...)[ソース]¶
バッファサイズによるフラッシュを行うFlushPolicyです。
- buffer_size¶
バッファサイズ
- Type
int
- class IntervalOrBufferSize(...)[ソース]¶
インターバル、またはバッファサイズによるフラッシュを行うFlushPolicyです。
- buffer_size¶
バッファサイズ
- Type
int
- interval¶
フラッシュインターバル(秒)
- Type
float