org.gradle.process.internal.worker.WorkerProcessFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 6.5 API redistribution.
/*
* Copyright 2016 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
*
* 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.gradle.process.internal.worker;
import org.gradle.api.Action;
public interface WorkerProcessFactory {
/**
* Creates a builder for workers that will run the given action. The worker action is serialized to the worker process and executed.
*
* The worker process is not started until {@link WorkerProcess#start()} is called.
*
* @param workerAction The action to serialize and run in the worker process.
*/
WorkerProcessBuilder create(Action workerAction);
/**
* Creates a builder for workers that will handle requests using the given worker implementation, with each request executed in a separate worker process.
*
* The worker process is not started until a method on the return value of {@link SingleRequestWorkerProcessBuilder#build()} is called.
*
* @param workerImplementation The implementation class to run in the worker process.
*/
SingleRequestWorkerProcessBuilder singleRequestWorker(Class> workerImplementation);
/**
* Creates a builder for workers that will handle requests using the given worker implementation, with a worker process handling zero or more requests.
* A worker process handles a single request at a time.
*
* The worker process is not started until {@link WorkerControl#start()} is called.
*
* @param workerImplementation The implementation class to run in the worker process.
*/
MultiRequestWorkerProcessBuilder multiRequestWorker(Class> workerImplementation);
}