spring-kafka KafkaConsumerBackoffManager 源码

  • 2022-08-16
  • 浏览 (471)

spring-kafka KafkaConsumerBackoffManager 代码

文件路径:/spring-kafka/src/main/java/org/springframework/kafka/listener/KafkaConsumerBackoffManager.java

/*
 * Copyright 2018-2021 the original author or authors.
 *
 * Licensed 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
 *
 *      https://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.springframework.kafka.listener;

import org.apache.kafka.clients.consumer.Consumer;
import org.apache.kafka.common.TopicPartition;

/**
 * Interface for backing off a {@link MessageListenerContainer}
 * until a given dueTimestamp, if such timestamp is in the future.
 *
 * @author Tomaz Fernandes
 * @author Gary Russell
 * @since 2.7
 */
public interface KafkaConsumerBackoffManager {

	void backOffIfNecessary(Context context);

	default Context createContext(long dueTimestamp, String listenerId, TopicPartition topicPartition,
								Consumer<?, ?> messageConsumer) {
		return new Context(dueTimestamp, topicPartition, listenerId, messageConsumer);
	}

	/**
	 * Provides the state that will be used for backing off.
	 * @since 2.7
	 */
	class Context {

		/**
		 * The time after which the message should be processed,
		 * in milliseconds since epoch.
		 */
		private final long dueTimestamp;

		/**
		 * The id for the listener that should be paused.
		 */
		private final String listenerId;

		/**
		 * The topic that contains the partition to be paused.
		 */
		private final TopicPartition topicPartition;

		/**
		 * The consumer of the message, if present.
		 */
		private final Consumer<?, ?> consumerForTimingAdjustment;

		Context(long dueTimestamp, TopicPartition topicPartition, String listenerId,
				Consumer<?, ?> consumerForTimingAdjustment) {

			this.dueTimestamp = dueTimestamp;
			this.listenerId = listenerId;
			this.topicPartition = topicPartition;
			this.consumerForTimingAdjustment = consumerForTimingAdjustment;
		}

		public long getDueTimestamp() {
			return this.dueTimestamp;
		}

		public String getListenerId() {
			return this.listenerId;
		}

		public TopicPartition getTopicPartition() {
			return this.topicPartition;
		}

		public Consumer<?, ?> getConsumerForTimingAdjustment() {
			return this.consumerForTimingAdjustment;
		}

	}

}

相关信息

spring-kafka 源码目录

相关文章

spring-kafka AbstractConsumerSeekAware 源码

spring-kafka AbstractKafkaBackOffManagerFactory 源码

spring-kafka AbstractMessageListenerContainer 源码

spring-kafka AcknowledgingConsumerAwareMessageListener 源码

spring-kafka AcknowledgingMessageListener 源码

spring-kafka AfterRollbackProcessor 源码

spring-kafka BackOffHandler 源码

spring-kafka BatchAcknowledgingConsumerAwareMessageListener 源码

spring-kafka BatchAcknowledgingMessageListener 源码

spring-kafka BatchConsumerAwareMessageListener 源码

0  赞