bt.event.EventSink 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.event;

import bt.data.Bitfield;
import bt.metainfo.Torrent;
import bt.metainfo.TorrentId;
import bt.net.ConnectionKey;
import bt.net.Peer;

/**
 * Provides API to generate runtime events.
 *
 * @since 1.5
 */
public interface EventSink {

    /**
     * Generate event, that a new peer has been discovered for some torrent.
     *
     * @since 1.5
     */
    void firePeerDiscovered(TorrentId torrentId, Peer peer);

    /**
     * Generate event, that a new connection with some peer has been established.
     *
     * @since 1.9
     */
    void firePeerConnected(ConnectionKey connectionKey);

    /**
     * Generate event, that a connection with some peer has been terminated.
     *
     * @since 1.9
     */
    void firePeerDisconnected(ConnectionKey connectionKey);

    /**
     * Generate event, that local information about some peer's data has been updated.
     *
     * @since 1.9
     */
    void firePeerBitfieldUpdated(TorrentId torrentId, ConnectionKey connectionKey, Bitfield bitfield);

    /**
     * Generate event, that processing of some torrent has begun.
     *
     * @since 1.5
     */
    void fireTorrentStarted(TorrentId torrentId);

    /**
     * Generate event, that torrent's metadata has been fetched.
     *
     * @since 1.9
     */
    void fireMetadataAvailable(TorrentId torrentId, Torrent torrent);

    /**
     * Generate event, that processing of some torrent has finished.
     *
     * @since 1.5
     */
    void fireTorrentStopped(TorrentId torrentId);

    /**
     * Generate event, that the downloading and verification
     * of one of torrent's pieces has been finished.
     *
     * @since 1.8
     */
    void firePieceVerified(TorrentId torrentId, int pieceIndex);
}