PeerSet.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2012, 2013 Ripple Labs Inc.
 
    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#ifndef RIPPLE_APP_PEERS_PEERSET_H_INCLUDED
#define RIPPLE_APP_PEERS_PEERSET_H_INCLUDED
 
#include <ripple/app/main/Application.h>
#include <ripple/beast/clock/abstract_clock.h>
#include <ripple/beast/utility/Journal.h>
#include <ripple/overlay/Peer.h>
#include <boost/asio/basic_waitable_timer.hpp>
#include <mutex>
#include <set>
 
namespace ripple {
 
class PeerSet
{
protected:
    using ScopedLockType = std::unique_lock<std::recursive_mutex>;
 
    PeerSet(
        Application& app,
        uint256 const& hash,
        std::chrono::milliseconds interval,
        beast::Journal journal);
 
    virtual ~PeerSet() = 0;
 
    void
    addPeers(
        std::size_t limit,
        std::function<bool(std::shared_ptr<Peer> const&)> score);
 
    virtual void
    onPeerAdded(std::shared_ptr<Peer> const&) = 0;
 
    virtual void
    onTimer(bool progress, ScopedLockType&) = 0;
 
    virtual void
    queueJob() = 0;
 
    virtual std::weak_ptr<PeerSet>
    pmDowncast() = 0;
 
    bool
    isDone() const
    {
        return mComplete || mFailed;
    }
 
    void
    invokeOnTimer();
 
    void
    sendRequest(
        const protocol::TMGetLedger& message,
        std::shared_ptr<Peer> const& peer);
 
    void
    setTimer();
 
    // Used in this class for access to boost::asio::io_service and
    // ripple::Overlay. Used in subtypes for the kitchen sink.
    Application& app_;
    beast::Journal m_journal;
 
    std::recursive_mutex mLock;
 
    uint256 const mHash;
    int mTimeouts;
    bool mComplete;
    bool mFailed;
    bool mProgress;
 
    std::set<Peer::id_t> mPeers;
 
private:
    std::chrono::milliseconds mTimerInterval;
    // VFALCO TODO move the responsibility for the timer to a higher level
    boost::asio::basic_waitable_timer<std::chrono::steady_clock> mTimer;
};
 
}  // namespace ripple
 
#endif