
org.apache.pinot.spi.stream.StreamLevelConsumer Maven / Gradle / Ivy
/**
* 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.pinot.spi.stream;
import org.apache.pinot.spi.annotations.InterfaceAudience;
import org.apache.pinot.spi.annotations.InterfaceStability;
import org.apache.pinot.spi.data.readers.GenericRow;
/**
* Interface for a consumer that consumes at stream level and is unaware of any partitions of the stream
*/
@InterfaceAudience.Public
@InterfaceStability.Stable
public interface StreamLevelConsumer {
/**
* Initialize and start the stream level consumer
* @throws Exception
*/
void start()
throws Exception;
/**
* Get next row from the stream and decode it into a generic row
* @param destination
* @return
*/
GenericRow next(GenericRow destination);
/**
* Commit the offsets consumed so far
* The next call to consume should exclude all events consumed before the commit was called, and start from newer
* events not yet consumed
*/
void commit();
/**
* Shutdown the stream consumer
* @throws Exception
*/
void shutdown()
throws Exception;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy