io.streamthoughts.azkarra.api.events.EventStreamPipe Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azkarra-api Show documentation

Azkarra Streams Core API

There is a newer version: 0.9.2

/*
 * Copyright 2019-2020 StreamThoughts.
 *
 * 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 io.streamthoughts.azkarra.api.events;

/**
 * The EventStreamPipe is used to attached or detach an object that will be responsible to consume
 * records send to an {@link EventStream}.
 *
 * @see EventStream#open(EventStreamPipe)
 *
 * @param    the record-key type.
 * @param    the record-value type.
 *
 * @since 0.8.0
 */
public interface EventStreamPipe {

    /**
     * Set the queue from which records are produced.
     *
     * @param queue the {@link BlockingRecordQueue}.
     */
    void onOpen(final BlockingRecordQueue queue);

}