`iscp.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)[ソース]¶

アップストリームを閉じます。

パラメータ:: overwrite_close_session (Optional[bool]) -- アップストリームに設定されている close_session を上書きします。

async flush()[ソース]¶: データポイントの内部バッファをUpstreamChunkとしてサーバーへ送信します。

async write_data_points(data_id, *data_points)[ソース]¶

データポイントを送信します。

パラメータ:

data_id (iscp.DataID) -- データID
*data_points (iscp.DataPoint) -- データポイント

property ack_interval¶

Ackの返却間隔を取得します。

戻り値:: Ackの返却間隔（秒）
戻り値の型:: float

property close_session¶

クローズ時にセッションをクローズするかどうかを取得します。

戻り値:: クローズ時にセッションをクローズするかどうか
戻り値の型:: bool

property close_timeout¶

クローズタイムアウト（秒）を取得します。

戻り値:: クローズタイムアウト（秒）
戻り値の型:: float

property expiry_interval¶

有効期限を取得します。

戻り値:: ストリームの有効期限（秒）
戻り値の型:: float

property flush_policy¶

フラッシュポリシーを取得します。

戻り値:: フラッシュポリシー
戻り値の型:: iscp.FlushPolicy

property id¶

ストリームIDを取得します。

戻り値:: ストリームID
戻り値の型:: UUID

property persist¶

永続化フラグを取得します。

戻り値:: 永続化フラグ
戻り値の型:: Bool

property qos¶

QoSを取得します。

戻り値:: QoS
戻り値の型:: iscp.QoS

property server_time¶

UpstreamResponseで返却されたサーバー時刻を取得します。

戻り値:: UpstreamResponseで返却されたサーバー時刻
戻り値の型:: iscp.DateTime

property session_id¶

セッションIDを取得します。

戻り値:: セッションID
戻り値の型:: str

property state¶

ストリームの状態を取得します。

戻り値:: アップストリームの状態
戻り値の型:: UpstreamState

アップストリーム関連の各種クラス¶

class UpstreamState[ソース]¶

アップストリームの状態を表します。

data_id_aliases¶

データIDエイリアスとデータ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 UpstreamChunk[ソース]¶

アップストリームチャンクを表します。

sequence_number¶

シーケンス番号

Type:: int

data_point_groups¶

データポイントグループのリスト

Type:: List[iscp.DataPointGroup]

class UpstreamChunkAck[ソース]¶

アップストリームチャンクに対する確認応答を表します。

results¶

処理結果のリスト

Type:: List[iscp.UpstreamChunkResult]

class UpstreamChunkResult[ソース]¶

アップストリームチャンクで送信されたデータポイントの処理結果を表します。

sequence_number¶

シーケンス番号

Type:: int

result_code¶

結果コード

Type:: iscp.ResultCode

result_string¶

結果文字列

Type:: str

class UpstreamMetadata[ソース]¶

アップストリームメタデータです。メタデータを格納してノードからブローカーへ転送するためのメッセージです。

metadata¶

メタデータ

Type:: SendableMetadata

extension_fields¶

拡張フィールド

Type:: iscp.UpstreamMetadataExtensionFields

iscp.Upstream - 上り用ストリーム¶

アップストリームを表すクラス¶

アップストリーム関連の各種クラス¶

`iscp.Upstream` - 上り用ストリーム¶