[GitHub] [kafka] philipnee commented on a diff in pull request #12663: KAFKA-14247: Define event handler interface and events
philipnee commented on code in PR #12663:
URL: https://github.com/apache/kafka/pull/12663#discussion_r984959163
##
clients/src/main/java/org/apache/kafka/clients/consumer/internals/AbstractPrototypeAsyncConsumer.java:
##
@@ -0,0 +1,124 @@
+/*
+ * 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.clients.consumer.internals;
+
+import org.apache.kafka.clients.consumer.Consumer;
+import org.apache.kafka.clients.consumer.ConsumerRecords;
+import org.apache.kafka.clients.consumer.internals.events.ApplicationEvent;
+import org.apache.kafka.clients.consumer.internals.events.BackgroundEvent;
+import org.apache.kafka.clients.consumer.internals.events.EventHandler;
+import org.apache.kafka.common.utils.Time;
+
+import java.time.Duration;
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
+/**
+ * This is the prototype of the consumer that uses the {@link EventHandler} to
process application events.
+ */
+public abstract class AbstractPrototypeAsyncConsumer implements
Consumer {
Review Comment:
Thanks, let's drop the Abstract prefix.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [kafka] philipnee commented on a diff in pull request #12663: KAFKA-14247: Define event handler interface and events
philipnee commented on code in PR #12663:
URL: https://github.com/apache/kafka/pull/12663#discussion_r982820685
##
clients/src/main/java/org/apache/kafka/clients/consumer/internals/AbstractPrototypeAsyncConsumer.java:
##
@@ -0,0 +1,119 @@
+/*
+ * 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.clients.consumer.internals;
+
+import org.apache.kafka.clients.consumer.Consumer;
+import org.apache.kafka.clients.consumer.ConsumerRecords;
+import org.apache.kafka.clients.consumer.internals.events.ApplicationEvent;
+import org.apache.kafka.clients.consumer.internals.events.BackgroundEvent;
+import org.apache.kafka.clients.consumer.internals.events.EventHandler;
+import org.apache.kafka.common.utils.Time;
+
+import java.time.Duration;
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
+/**
+ * This is the prototype of the consumer that uses the {@link EventHandler} to
process application events.
+ */
+public abstract class AbstractPrototypeAsyncConsumer implements
Consumer {
+private final EventHandler eventHandler;
+private final Time time;
+
+public AbstractPrototypeAsyncConsumer(final Time time, final EventHandler
eventHandler) {
+this.eventHandler = eventHandler;
+this.time = time;
+}
+
+/**
+ * poll implementation using {@link EventHandler}.
+ * 1. Poll for background events. If there's a fetch response event,
process the record and return it. If it is
+ * another type of event, process it.
+ * 2. Send fetches if needed.
+ * If the timeout expires, return an empty ConsumerRecord.
+ * @param timeout timeout of the poll loop
+ * @return ConsumerRecord. It can be empty if time timeout expires.
+ */
+@Override
+public ConsumerRecords poll(final Duration timeout) {
+try {
+do {
+if (!eventHandler.isEmpty()) {
+Optional backgroundEvent =
eventHandler.poll();
+if (backgroundEvent.isPresent()) {
+if (isFetchResult(backgroundEvent.get())) {
+// return fetches
+return processFetchResult(backgroundEvent.get());
+}
+processEvent(backgroundEvent.get(), timeout); // might
trigger callbacks or handle exceptions
+}
+}
+
+maybeSendFetches(); // send new fetches
Review Comment:
Thanks, @hachikuji - removed this line per your comment.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [kafka] philipnee commented on a diff in pull request #12663: KAFKA-14247: Define event handler interface and events
philipnee commented on code in PR #12663:
URL: https://github.com/apache/kafka/pull/12663#discussion_r982803945
##
clients/src/main/java/org/apache/kafka/clients/consumer/internals/AbstractPrototypeAsyncConsumer.java:
##
@@ -0,0 +1,119 @@
+/*
+ * 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.clients.consumer.internals;
+
+import org.apache.kafka.clients.consumer.Consumer;
+import org.apache.kafka.clients.consumer.ConsumerRecords;
+import org.apache.kafka.clients.consumer.internals.events.ApplicationEvent;
+import org.apache.kafka.clients.consumer.internals.events.BackgroundEvent;
+import org.apache.kafka.clients.consumer.internals.events.EventHandler;
+import org.apache.kafka.common.utils.Time;
+
+import java.time.Duration;
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
+/**
+ * This is the prototype of the consumer that uses the {@link EventHandler} to
process application events.
+ */
+public abstract class AbstractPrototypeAsyncConsumer implements
Consumer {
+private final EventHandler eventHandler;
+private final Time time;
+
+public AbstractPrototypeAsyncConsumer(final Time time, final EventHandler
eventHandler) {
+this.eventHandler = eventHandler;
+this.time = time;
+}
+
+/**
+ * poll implementation using {@link EventHandler}.
+ * 1. Poll for background events. If there's a fetch response event,
process the record and return it. If it is
+ * another type of event, process it.
+ * 2. Send fetches if needed.
+ * If the timeout expires, return an empty ConsumerRecord.
+ * @param timeout timeout of the poll loop
+ * @return ConsumerRecord. It can be empty if time timeout expires.
+ */
+@Override
+public ConsumerRecords poll(final Duration timeout) {
+try {
+do {
+if (!eventHandler.isEmpty()) {
+Optional backgroundEvent =
eventHandler.poll();
+if (backgroundEvent.isPresent()) {
+if (isFetchResult(backgroundEvent.get())) {
+// return fetches
+return processFetchResult(backgroundEvent.get());
+}
+processEvent(backgroundEvent.get(), timeout); // might
trigger callbacks or handle exceptions
+}
+}
+
+maybeSendFetches(); // send new fetches
Review Comment:
the intention was to enqueue a fetch event, I think we still want the poll
loop to drive the fetching, right? Maybe a better naming is needed.
`enqueueFetchEvent()` perhaps?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [kafka] philipnee commented on a diff in pull request #12663: KAFKA-14247: Define event handler interface and events
philipnee commented on code in PR #12663:
URL: https://github.com/apache/kafka/pull/12663#discussion_r980468305
##
clients/src/main/java/org/apache/kafka/clients/consumer/internals/events/EventHandler.java:
##
@@ -0,0 +1,46 @@
+/*
+ * 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.clients.consumer.internals.events;
+
+import java.util.Optional;
+
+/**
+ * This class interfaces with the KafkaConsumer and the background thread. It
allows the caller to enqueue events via
+ * the {@code add()} method and to retrieve events via the {@code poll()}
method.
+ */
+public interface EventHandler {
Review Comment:
I don't think we need another handler on the background thread, what I'm
thinking is to have the background thread living inside of the handler
implementation, process the application events, and produce the background
events.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [kafka] philipnee commented on a diff in pull request #12663: KAFKA-14247: Define event handler interface and events
philipnee commented on code in PR #12663:
URL: https://github.com/apache/kafka/pull/12663#discussion_r976908482
##
clients/src/main/java/org/apache/kafka/clients/consumer/internals/events/EventHandler.java:
##
@@ -0,0 +1,27 @@
+/*
+ * 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.clients.consumer.internals.events;
+
+/**
+ * This class interfaces with the KafkaConsumer and the background thread. It
allows the caller to enqueue events via
+ * the {@code add()} method and to retrieve events via the {@code poll()}
method.
+ */
+public interface EventHandler {
+public BackgroundEvent poll();
Review Comment:
Thanks @hachikuji - I'm making it to return an Optional. Another question
raised here, I think we need to handle the exceptions thrown by
blockingQueue.add. I'm looking at the RaftMessageQueue impl, the exceptions
aren't being handled there, are we expecting the caller/client to handle these
exceptions?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
