iSCP - リアルタイムAPI¶

リアルタイム通信用エンドポイントへのアクセスAPIを提供します。

Request Methods¶

警告

以下のアクセスオブジェクトは、必ず client の connect_iscp() を使用して生成してください。

client = intdash.Client(...)
conn = await client.connect_iscp()

class ISCPConn(...)[ソース]¶

WebSocket 接続を表すオブジェクトです。

async close()[ソース]¶: intdashサーバーとの接続を切断します。

property is_closed¶

コネクションが閉じているか

Type: bool

async open_downstream(spec, on_msg=None)[ソース]¶

指定した仕様でダウンストリームを開きます。

パラメータ

spec (intdash.DownstreamSpec) -- ダウンストリームスペック
on_msg (func) -- データを受信したときに呼ばれるコールバック

戻り値

ダウンストリームを表すオブジェクト

戻り値の型

Downstream

async open_upstream(spec, marker_interval=1, on_ack=None)[ソース]¶

指定した仕様でアップストリームを開きます。

パラメータ

spec (intdash.UpstreamSpec) -- アップストリームスペック
marker_interval (int) -- 秒単位のマーカー間隔
on_ack (func) -- SectionAckを受信したときに呼ばれるコールバック

戻り値

アップストリームを表すオブジェクト

戻り値の型

Upstream

Request Params¶

class DownstreamSpec(...)[ソース]

ダウンストリームスペックを表すオブジェクトです。

src_edge_uuid

送信元エッジUUID

Type: str

filters

データフィルタのリスト

Type: list[DataFilter]

dst_edge_uuid

送信先エッジUUID

Type: str

class DataFilter(...)[ソース]

データフィルタを表すオブジェクトです。

data_type

データタイプ

Type: DataType

channel

チャンネル番号

Type: int

data_id

データID

Type: str

class UpstreamSpec(...)[ソース]

アップストリームスペックを表すオブジェクトです。

src_edge_uuid

送信元エッジUUID

Type: str

dst_edge_uuids

送信先エッジUUIDのリスト

Type: list[str]

resend

再送フラグ

Type: bool

store

永続化フラグ

Type: bool

measurement_uuid

計測UUID

Type: str