Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.kafka.streams.processor.internals;

import java.time.Duration;
import java.util.List;
import java.util.Set;

public interface StateUpdater {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An implementation of the state updater is passed to the task manager in its constructor. Since the threading model of the state updater is encapsulated and one can pass the same state updater to multiple task managers there is no fixed 1:1 relationship between a restoration thread and a stream thread.


/**
* Adds a task (active or standby) to the state updater.
*
* @param task task to add
*/
void add(final Task task);
Copy link
Member Author

@cadonna cadonna Nov 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Each time an active or standby task transits to state RESTORING it needs to be added to the state updater.


/**
* Removes a task (active or standby) from the state updater.
*
* @param task task ro remove
*/
void remove(final Task task);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Each time a task is suspended in state RESTORING, we need to remove it from the state updater.


/**
* Gets restored active tasks from state restoration/update
*
* @param timeout duration how long the calling thread should wait for restored active tasks
*
* @return list of active tasks with up-to-date states
*/
Set<StreamTask> getRestoredActiveTasks(final Duration timeout);

/**
* Gets a list of exceptions thrown during restoration.
*
* @return exceptions
*/
List<RuntimeException> getExceptions();


/**
* Get all tasks (active and standby) that are managed by the state updater.
*
* @return list of tasks managed by the state updater
*/
Set<Task> getAllTasks();

/**
* Shuts down the state updater.
*
* @param timeout duration how long to wait until the state updater is shut down
*/
void shutdown(final Duration timeout);
}