Class DynamicBarrierValue<Value>Internal

constructor

• new DynamicBarrierValue<Value>(): DynamicBarrierValue<Value>

• Type Parameters

  • Value

  Returns DynamicBarrierValue<Value>

lc_graph_name

Optional names

seen

checkpoint

• checkpoint(): [undefined | Value[], Value[]]

• Return a string representation of the channel's current state.

  Returns [undefined | Value[], Value[]]

  Throws

  if the channel is empty (never updated yet), or doesn't support checkpoints.

consume

• consume(): boolean

• Mark the current value of the channel as consumed. By default, no-op. This is called by Pregel before the start of the next step, for all channels that triggered a node. If the channel was updated, return true.

  Returns boolean

fromCheckpoint

• fromCheckpoint(checkpoint?): this

• Return a new identical channel, optionally initialized from a checkpoint. Can be thought of as a "restoration" from a checkpoint which is a "snapshot" of the channel's state.

  Parameters

  • Optional checkpoint: [undefined | Value[], Value[]]

  Returns this

get

• get(): void

• Return the current value of the channel.

  Returns void

  Throws

  if the channel is empty (never updated yet).

update

• update(values): boolean

• Update the channel's value with the given sequence of updates. The order of the updates in the sequence is arbitrary. This method is called by Pregel for all channels at the end of each step. If there are no updates, it is called with an empty sequence.

  Raises InvalidUpdateError if the sequence of updates is invalid. Returns True if the channel was updated, False otherwise.

  Parameters

  • values: (Value | WaitForNames<Value>)[]

  Returns boolean

  Throws

  if the sequence of updates is invalid.