类 BaseChannel<ValueType, UpdateType, CheckpointType>抽象类

constructor

• new BaseChannel<ValueType, UpdateType, CheckpointType>(): BaseChannel<ValueType, UpdateType, CheckpointType>

• 类型参数

  • ValueType = unknown
  • UpdateType = unknown
  • CheckpointType = unknown

  返回 BaseChannel<ValueType, UpdateType, CheckpointType>

UpdateType

ValueType

抽象类 lc_graph_name

抽象类 checkpoint

• checkpoint(): undefined | CheckpointType

• 返回通道当前状态的字符串表示形式。

  返回 undefined | CheckpointType

  抛出

  如果通道为空（尚未更新），或者不支持检查点。

consume

• consume(): boolean

• 将通道的当前值标记为已消费。 默认情况下，无操作。 这由 Pregel 在下一步开始之前为所有触发节点的通道调用。 如果通道已更新，则返回 true。

  返回 boolean

抽象类 fromCheckpoint

• fromCheckpoint(checkpoint?): this

• 返回一个新的相同的通道，可以选择从检查点初始化。 可以将其视为从检查点的“恢复”，“检查点”是通道状态的“快照”。

  参数

  • 可选 checkpoint: CheckpointType

  返回 this

抽象类 get

• get(): ValueType

• 返回通道的当前值。

  返回 ValueType

  抛出

  如果通道为空（尚未更新）。

抽象类 update

• update(values): boolean

• 使用给定的更新序列更新通道的值。 序列中更新的顺序是任意的。 Pregel 在每个步骤结束时为所有通道调用此方法。 如果没有更新，则使用空序列调用它。

  如果更新序列无效，则引发 InvalidUpdateError。 如果通道已更新，则返回 True，否则返回 False。

  参数

  • values: UpdateType[]

  返回 boolean

  抛出

  如果更新序列无效。