io.mokamint.miner.remote.RemoteMiners Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of io-mokamint-miner-remote Show documentation

This module implements a remote miner, that is, a miner that works by forwarding its work to remote services connected by network.

There is a newer version: 1.1.0

Show newest version

/*
Copyright 2023 Fausto Spoto

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 io.mokamint.miner.remote;

import java.io.IOException;

import io.mokamint.miner.api.Miner;
import io.mokamint.miner.remote.internal.RemoteMinerImpl;
import io.mokamint.nonce.api.DeadlineValidityCheck;
import jakarta.websocket.DeploymentException;

/**
 * Provider of a miner that connects to a remote mining service.
 */
public abstract class RemoteMiners {

	private RemoteMiners() {}

	/**
	 * Yields and opens a new remote miner.
	 * 
	 * @param port the http port where the server is opened on localhost
	 * @param check an algorithm to check if a deadline is valid for the node this miner is working for
	 * @return the new remote miner
	 * @throws DeploymentException if the remote mining endpoint could not be deployed
	 * @throws IOException if an I/O error occurs
	 */
	public static Miner of(int port, DeadlineValidityCheck check) throws DeploymentException, IOException {
		return new RemoteMinerImpl(port, check);
	}
}