类 BaseChannel<ValueType, UpdateType, CheckpointType>抽象

构造函数

• 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

• 将通道的当前值标记为已消费。默认情况下，不执行任何操作。通道可以使用此方法修改其状态，防止值被再次消费。

  如果通道已更新，则返回 True，否则返回 False。

  返回 boolean

finish

• finish(): boolean

• 通知通道 Pregel 运行即将结束。默认情况下，不执行任何操作。通道可以使用此方法修改其状态，防止结束。

  如果通道已更新，则返回 True，否则返回 False。

  返回 boolean

抽象 fromCheckpoint

• fromCheckpoint(checkpoint?): this

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

  参数

  • 可选 checkpoint: CheckpointType

  返回 this

抽象 get

• get(): ValueType

• 返回通道的当前值。

  返回 ValueType

  抛出

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

isAvailable

• isAvailable(): boolean

• 如果通道可用（不为空），则返回 True，否则返回 False。子类应覆盖此方法以提供比调用 get() 并捕获 EmptyChannelError 更高效的实现。

  返回 boolean

抽象 update

• update(values): boolean

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

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

  参数

  • values: UpdateType[]

  返回 boolean

  抛出

  如果更新序列无效。