You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
NOTE: `register` is part of the <<kafka-streams-ProcessorContext.adoc#register, ProcessorContext Contract>> to register a <<kafka-streams-StateStore.adoc#, state store>>.
69
69
70
-
`register` simply requests the <<stateManager, StateManager>> to <<kafka-streams-StateManager.adoc#register, register the state store>> (and the given <<kafka-streams-StateRestoreCallback.adoc#, StateRestoreCallback>>)
70
+
`register` simply requests the <<stateManager, StateManager>> to <<kafka-streams-internals-StateManager.adoc#register, register the state store>> (and the given <<kafka-streams-StateRestoreCallback.adoc#, StateRestoreCallback>>)
71
71
72
72
`register` throws an `IllegalStateException` when <<initialized, initialized>>:
73
73
@@ -93,7 +93,7 @@ NOTE: `uninitialize` is part of the <<kafka-streams-internals-InternalProcessorC
Copy file name to clipboardexpand all lines: kafka-streams-AbstractStateManager.adoc
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
== [[AbstractStateManager]] AbstractStateManager -- Base State Manager
2
2
3
-
`AbstractStateManager` is the base implementation of the <<kafka-streams-StateManager.adoc#, StateManager contract>> for <<implementations, state managers>> that use <<checkpoint, offset checkpointing>>.
3
+
`AbstractStateManager` is the base implementation of the <<kafka-streams-internals-StateManager.adoc#, StateManager contract>> for <<implementations, state managers>> that use <<checkpoint, offset checkpointing>>.
4
4
5
5
NOTE: `AbstractStateManager` is a Java abstract class and cannot be <<creating-instance, created>> directly. It is created indirectly for the <<implementations, concrete AbstractStateManagers>>.
Copy file name to clipboardexpand all lines: kafka-streams-Checkpointable.adoc
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
`Checkpointable` is the internal <<contract, contract>> for <<implementations, objects>> with associated partition offsets that can be <<checkpoint, checkpointed>>.
4
4
5
5
[[implementations]]
6
-
NOTE: <<kafka-streams-StateManager.adoc#, StateManager>> is the one and only known direct extension contract of the <<contract, Checkpointable Contract>>.
6
+
NOTE: <<kafka-streams-internals-StateManager.adoc#, StateManager>> is the one and only known direct extension contract of the <<contract, Checkpointable Contract>>.
Copy file name to clipboardexpand all lines: kafka-streams-GlobalStateManager.adoc
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
== [[GlobalStateManager]] GlobalStateManager
2
2
3
-
`GlobalStateManager` is the <<contract, contract>> for custom link:kafka-streams-StateManager.adoc[StateManagers] that are link:kafka-streams-Checkpointable.adoc[checkpointable] and...FIXME
3
+
`GlobalStateManager` is the <<contract, contract>> for custom link:kafka-streams-internals-StateManager.adoc[StateManagers] that are link:kafka-streams-Checkpointable.adoc[checkpointable] and...FIXME
`ProcessorStateManager` is a concrete <<kafka-streams-StateManager.adoc#, StateManager>> (as a <<kafka-streams-AbstractStateManager.adoc#, AbstractStateManager>>) that...FIXME
3
+
`ProcessorStateManager` is a concrete <<kafka-streams-internals-StateManager.adoc#, StateManager>> (as a <<kafka-streams-AbstractStateManager.adoc#, AbstractStateManager>>) that...FIXME
4
4
5
5
`ProcessorStateManager` is <<creating-instance, created>> exclusively when `AbstractTask` is <<kafka-streams-internals-AbstractTask.adoc#stateMgr, created>> (for <<kafka-streams-internals-StandbyTask.adoc#, StandbyTask>> and <<kafka-streams-internals-StreamTask.adoc#, StreamTask>> tasks).
6
6
@@ -73,7 +73,7 @@ void register(
73
73
final StateRestoreCallback stateRestoreCallback)
74
74
----
75
75
76
-
NOTE: `register` is part of link:kafka-streams-StateManager.adoc#register[StateManager Contract] to register a <<kafka-streams-StateStore.adoc#, state store>> and the associated `StateRestoreCallback`.
76
+
NOTE: `register` is part of link:kafka-streams-internals-StateManager.adoc#register[StateManager Contract] to register a <<kafka-streams-StateStore.adoc#, state store>> and the associated `StateRestoreCallback`.
77
77
78
78
`register` prints out the following DEBUG message to the logs:
79
79
@@ -118,7 +118,7 @@ Store [storeName] has already been registered.
NOTE: `close` is part of link:kafka-streams-StateManager.adoc#close[StateManager Contract] to...FIXME.
121
+
NOTE: `close` is part of link:kafka-streams-internals-StateManager.adoc#close[StateManager Contract] to...FIXME.
122
122
123
123
`close`...FIXME
124
124
@@ -129,7 +129,7 @@ NOTE: `close` is part of link:kafka-streams-StateManager.adoc#close[StateManager
129
129
void flush()
130
130
----
131
131
132
-
NOTE: `flush` is part of the <<kafka-streams-StateManager.adoc#flush, StateManager Contract>> to flush all <<kafka-streams-StateStore.adoc#, state stores>> registered with the state manager.
132
+
NOTE: `flush` is part of the <<kafka-streams-internals-StateManager.adoc#flush, StateManager Contract>> to flush all <<kafka-streams-StateStore.adoc#, state stores>> registered with the state manager.
133
133
134
134
`flush`...FIXME
135
135
@@ -140,7 +140,7 @@ NOTE: `flush` is part of the <<kafka-streams-StateManager.adoc#flush, StateManag
140
140
StateStore getGlobalStore(final String name)
141
141
----
142
142
143
-
NOTE: `getGlobalStore` is part of link:kafka-streams-StateManager.adoc#getGlobalStore[StateManager Contract] to...FIXME.
143
+
NOTE: `getGlobalStore` is part of link:kafka-streams-internals-StateManager.adoc#getGlobalStore[StateManager Contract] to...FIXME.
144
144
145
145
`getGlobalStore`...FIXME
146
146
@@ -151,7 +151,7 @@ NOTE: `getGlobalStore` is part of link:kafka-streams-StateManager.adoc#getGlobal
151
151
StateStore getStore(final String name)
152
152
----
153
153
154
-
NOTE: `getStore` is part of link:kafka-streams-StateManager.adoc#getStore[StateManager Contract] to...FIXME.
154
+
NOTE: `getStore` is part of link:kafka-streams-internals-StateManager.adoc#getStore[StateManager Contract] to...FIXME.
NOTE: `reinitializeStateStoresForPartitions` is part of <<kafka-streams-StateManager.adoc#reinitializeStateStoresForPartitions, StateManager Contract>> to...FIXME.
167
+
NOTE: `reinitializeStateStoresForPartitions` is part of <<kafka-streams-internals-StateManager.adoc#reinitializeStateStoresForPartitions, StateManager Contract>> to...FIXME.
* `DefaultPartitionGrouper` is requested to <<kafka-streams-DefaultPartitionGrouper.adoc#partitionGroups, partitionGroups>>
12
+
13
+
* `GlobalProcessorContextImpl` is <<kafka-streams-internals-GlobalProcessorContextImpl.adoc#, created>>
14
+
15
+
* `TaskId` is requested to <<parse, parse>> and <<readFrom, readFrom>>
16
+
17
+
[[toString]]
18
+
When requested for a textual representation (`toString`), `TaskId` simply returns the <<topicGroupId, topic group ID>> and the <<partition, assigned partition ID>> separated by `_` (underscore), e.g. `0_0`.
19
+
20
+
[source, scala]
21
+
----
22
+
import org.apache.kafka.streams.processor.TaskId
23
+
val topicGroupId = 0
24
+
val partition = 0
25
+
val tid = new TaskId(topicGroupId, partition)
26
+
scala> println(tid)
27
+
0_0
28
+
----
29
+
30
+
=== [[parse]] Creating TaskId from Textual Representation --`parse` Factory Method
31
+
32
+
[source, java]
33
+
----
34
+
TaskId parse(final String taskIdStr)
35
+
----
36
+
37
+
`parse` <<creating-instance, creates>> a `TaskId` from the given textual representation.
38
+
39
+
`parse` throws a `TaskIdFormatException` if the given `taskIdStr` is of incorrect format.
40
+
41
+
[source, scala]
42
+
----
43
+
import org.apache.kafka.streams.processor.TaskId
44
+
val incorrectTaskId = "hello_world"
45
+
scala> TaskId.parse(incorrectTaskId)
46
+
org.apache.kafka.streams.errors.TaskIdFormatException: Task id cannot be parsed correctly from hello_world
47
+
at org.apache.kafka.streams.processor.TaskId.parse(TaskId.java:58)
48
+
... 36 elided
49
+
----
50
+
51
+
[NOTE]
52
+
====
53
+
`parse` is used when:
54
+
55
+
* `StateDirectory` is requested to <<kafka-streams-internals-StateDirectory.adoc#cleanRemovedTasks, cleanRemovedTasks>>
56
+
57
+
* `TaskManager` is requested to <<kafka-streams-internals-TaskManager.adoc#cachedTasksIds, cachedTasksIds>>
`writeTo` simply writes the <<topicGroupId, topicGroupId>> and the <<partition, partition>> out to the given output (either `buf` or `out`).
69
+
70
+
[NOTE]
71
+
====
72
+
`writeTo` is used when:
73
+
74
+
* `SubscriptionInfo` is requested to <<kafka-streams-internals-SubscriptionInfo.adoc#encodeTasks, encodeTasks>>
75
+
76
+
* `AssignmentInfo` is requested to <<kafka-streams-internals-AssignmentInfo.adoc#encodeActiveAndStandbyTaskAssignment, encodeActiveAndStandbyTaskAssignment>>
`readFrom` simply creates a `TaskId` from (the numbers) from the given input (either `buf` or `in`).
88
+
89
+
[NOTE]
90
+
====
91
+
`readFrom` is used when:
92
+
93
+
* `SubscriptionInfo` is requested to <<kafka-streams-internals-SubscriptionInfo.adoc#decodeTasks, decodeTasks>>
94
+
95
+
* `AssignmentInfo` is requested to <<kafka-streams-internals-AssignmentInfo.adoc#decodeActiveTasks, decodeActiveTasks>> and <<kafka-streams-internals-AssignmentInfo.adoc#decodeStandbyTasks, decodeStandbyTasks>>
Copy file name to clipboardexpand all lines: kafka-streams-internals-GlobalProcessorContextImpl.adoc
+2-2
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,9 @@
6
6
7
7
[source, java]
8
8
----
9
-
FIXME
9
+
StateStore getStateStore(final String name)
10
10
----
11
11
12
12
NOTE: `getStateStore` is part of the <<kafka-streams-ProcessorContext.adoc#getStateStore, ProcessorContext Contract>> to...FIXME.
13
13
14
-
`getStateStore`...FIXME
14
+
`getStateStore` simply requests the <<kafka-streams-AbstractProcessorContext.adoc#stateManager, StateManager>> to <<kafka-streams-internals-StateManager.adoc#getGlobalStore, get the global state store>> by the given name.
NOTE: `reinitializeStateStoresForPartitions` is part of <<kafka-streams-StateManager.adoc#reinitializeStateStoresForPartitions, StateManager Contract>> to...FIXME.
51
+
NOTE: `reinitializeStateStoresForPartitions` is part of <<kafka-streams-internals-StateManager.adoc#reinitializeStateStoresForPartitions, StateManager Contract>> to...FIXME.
52
52
53
53
`reinitializeStateStoresForPartitions`...FIXME
54
54
@@ -59,7 +59,7 @@ NOTE: `reinitializeStateStoresForPartitions` is part of <<kafka-streams-StateMan
59
59
void flush()
60
60
----
61
61
62
-
NOTE: `flush` is part of the <<kafka-streams-StateManager.adoc#flush, StateManager Contract>> to flush all <<kafka-streams-StateStore.adoc#, state stores>> registered with the state manager.
62
+
NOTE: `flush` is part of the <<kafka-streams-internals-StateManager.adoc#flush, StateManager Contract>> to flush all <<kafka-streams-StateStore.adoc#, state stores>> registered with the state manager.
63
63
64
64
`flush`...FIXME
65
65
@@ -87,7 +87,7 @@ void register(
87
87
final StateRestoreCallback stateRestoreCallback)
88
88
----
89
89
90
-
NOTE: `register` is part of the <<kafka-streams-StateManager.adoc#register, StateManager Contract>> to register a <<kafka-streams-StateStore.adoc#, state store>>.
90
+
NOTE: `register` is part of the <<kafka-streams-internals-StateManager.adoc#register, StateManager Contract>> to register a <<kafka-streams-StateStore.adoc#, state store>>.
91
91
92
92
`register`...FIXME
93
93
@@ -98,6 +98,6 @@ NOTE: `register` is part of the <<kafka-streams-StateManager.adoc#register, Stat
Copy file name to clipboardexpand all lines: kafka-streams-internals-GlobalStateUpdateTask.adoc
+3-3
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ void flushState()
57
57
58
58
NOTE: `flushState` is part of link:kafka-streams-internals-GlobalStateMaintainer.adoc#flushState[GlobalStateMaintainer Contract] to...FIXME.
59
59
60
-
`flushState` requests <<stateMgr, GlobalStateManager>> to link:kafka-streams-StateManager.adoc#flush[flush] followed by link:kafka-streams-Checkpointable.adoc#checkpoint[checkpointing] the <<offsets, offsets>>.
60
+
`flushState` requests <<stateMgr, GlobalStateManager>> to link:kafka-streams-internals-StateManager.adoc#flush[flush] followed by link:kafka-streams-Checkpointable.adoc#checkpoint[checkpointing] the <<offsets, offsets>>.
61
61
62
62
=== [[close]] Closing State Manager -- `close` Method
63
63
@@ -66,9 +66,9 @@ NOTE: `flushState` is part of link:kafka-streams-internals-GlobalStateMaintainer
66
66
void close() throws IOException
67
67
----
68
68
69
-
NOTE: `close` is part of link:kafka-streams-StateManager.adoc#close[StateManager Contract] to...FIXME.
69
+
NOTE: `close` is part of link:kafka-streams-internals-StateManager.adoc#close[StateManager Contract] to...FIXME.
70
70
71
-
`close` simply requests <<stateMgr, GlobalStateManager>> to link:kafka-streams-StateManager.adoc#close[close] (passing on the <<offsets, offsets>>).
71
+
`close` simply requests <<stateMgr, GlobalStateManager>> to link:kafka-streams-internals-StateManager.adoc#close[close] (passing on the <<offsets, offsets>>).
0 commit comments