bt.processor.Processor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bt-core Show documentation

BitTorrent Client Library (Core)

The newest version!

/*
 * Copyright (c) 2016—2021 Andrei Tomashpolskiy and individual contributors.
 *
 * 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
 *
 *     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 bt.processor;

import bt.processor.listener.ListenerSource;

import java.util.concurrent.CompletableFuture;

/**
 * Generic asynchronous context processor.
 *
 * Typically, a processor encapsulates a series of stages (a processing chain),
 * that should be performed in order to achieve some desired effect or produce some result.
 *
 * It uses a context to transfer the processing state between different stages
 * and listeners to produce notifications about reaching significant processing milestones
 * and optionally perform context-based routing.
 *
 * @param  Type of processing context
 * @since 1.5
 */
public interface Processor {

    /**
     * Begin asynchronous processing of a given context.
     *
     * Returns a future, that can be used for
     * - waiting synchronously for the processing to complete,
     * - building processing pipelines and coordinating parallel executions,
     * - completing or cancelling the processing.
     *
     * @param context Processing context, that contains all necessary data to begin the processing
     * @param listenerSource Listeners
     * @return Future
     * @since 1.5
     */
    CompletableFuture process(C context, ListenerSource listenerSource);
}