bt.it.fixture.SwarmPeer Maven / Gradle / Ivy

Go to download
/*
 * 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.it.fixture;

import bt.net.Peer;
import bt.peer.IPeerRegistry;
import bt.runtime.BtClient;
import bt.runtime.BtRuntime;

import java.io.Closeable;
import java.io.IOException;

/**
 * Swarm participant.
 *
 * All instances of this class are closed by the containing swarm,
 * so it's not necessary to call {@link #close()} in tests.
 *
 * @since 1.0
 */
public abstract class SwarmPeer implements Closeable {

    protected BtRuntime runtime;

    /**
     * Create a swarm participant with the provided runtime.
     * The created instance should be the exclusive user of this runtime
     * (i.e. no other swarm participants should be created with the same runtime).
     *
     * @param runtime Bt runtime, that this peer will attach to
     * @since 1.0
     */
    protected SwarmPeer(BtRuntime runtime) {
        this.runtime = runtime;
    }

    /**
     * Get standard Bt peer, representing this swarm participant.
     *
     * @return Unique peer instance, representing this swarm participant
     * @since 1.0
     */
    public Peer getPeer() {
        return runtime.service(IPeerRegistry.class).getLocalPeer();
    }

    /**
     * Get Bt client instance for controlling this swarm participant.
     *
     * @return Bt client instance for controlling this swarm participant.
     * @since 1.0
     */
    public abstract BtClient getHandle();

    /**
     * @return true if this swarm participant is a seeder.
     * @since 1.0
     */
    public abstract boolean isSeeding();

    @Override
    public void close() throws IOException {
        runtime.shutdown();
    }
}