kafka-streams-internals-Checkpointable.adoc

Checkpointable Internal Contract

Checkpointable is the internal contract for objects with associated partition offsets that can be checkpointed.

Note	StateManager is the one and only known direct extension contract of the Checkpointable Contract.

Table 1. Checkpointable Contract

Method	Description
checkpoint	void checkpoint(final Map<TopicPartition, Long> offsets) Checkpointing offsets Used when: GlobalStateUpdateTask is requested to flush state stores StandbyTask is requested to flushAndCheckpointState (when requested to commit and suspend) StreamTask is requested to commit (with exactly-once support disabled) and suspend (with exactly-once support enabled)
checkpointed	Map<TopicPartition, Long> checkpointed() Used when: GlobalStateUpdateTask is requested to initialize StandbyTask is requested to initialize state stores