yac.hpp

Go to the documentation of this file.

#ifndef IROHA_YAC_HPP
#define IROHA_YAC_HPP

#include "consensus/yac/transport/yac_network_interface.hpp"  // for YacNetworkNotifications
#include "consensus/yac/yac_gate.hpp"                         // for HashGate

#include <memory>
#include <mutex>

#include <boost/optional.hpp>
#include <rxcpp/rx-lite.hpp>
#include "consensus/yac/cluster_order.hpp"     //  for ClusterOrdering
#include "consensus/yac/outcome_messages.hpp"  // because messages passed by value
#include "consensus/yac/storage/yac_vote_storage.hpp"  // for VoteStorage
#include "logger/logger_fwd.hpp"

#include <rxcpp/operators/rx-observe_on.hpp>

namespace iroha {
  namespace consensus {
    namespace yac {

      class YacCryptoProvider;
      class Timer;

      class Yac : public HashGate, public YacNetworkNotifications {
       public:
        static std::shared_ptr<Yac> create(
            YacVoteStorage vote_storage,
            std::shared_ptr<YacNetwork> network,
            std::shared_ptr<YacCryptoProvider> crypto,
            std::shared_ptr<Timer> timer,
            ClusterOrdering order,
            Round round,
            rxcpp::observe_on_one_worker worker,
            logger::LoggerPtr log);

        Yac(YacVoteStorage vote_storage,
            std::shared_ptr<YacNetwork> network,
            std::shared_ptr<YacCryptoProvider> crypto,
            std::shared_ptr<Timer> timer,
            ClusterOrdering order,
            Round round,
            rxcpp::observe_on_one_worker worker,
            logger::LoggerPtr log);

        ~Yac() override;

        // ------|Hash gate|------

        void vote(YacHash hash,
                  ClusterOrdering order,
                  boost::optional<ClusterOrdering> alternative_order =
                      boost::none) override;

        rxcpp::observable<Answer> onOutcome() override;

        // ------|Network notifications|------

        void onState(std::vector<VoteMessage> state) override;

        void stop() override;

       private:
        // ------|Private interface|------

        void votingStep(VoteMessage vote);

        void closeRound();

        ClusterOrdering &getCurrentOrder();

        boost::optional<std::shared_ptr<shared_model::interface::Peer>>
        findPeer(const VoteMessage &vote);

        void removeUnknownPeersVotes(std::vector<VoteMessage> &votes,
                                     ClusterOrdering &order);

        // ------|Apply data|------
        void applyState(const std::vector<VoteMessage> &state,
                        std::unique_lock<std::mutex> &lock);

        // ------|Propagation|------
        void propagateState(const std::vector<VoteMessage> &msg);
        void propagateStateDirectly(const shared_model::interface::Peer &to,
                                    const std::vector<VoteMessage> &msg);
        void tryPropagateBack(const std::vector<VoteMessage> &state);

        // ------|Logger|------
        logger::LoggerPtr log_;

        std::mutex mutex_;

        // ------|One round|------
        ClusterOrdering cluster_order_;
        boost::optional<ClusterOrdering> alternative_order_;
        Round round_;

        // ------|Fields|------
        rxcpp::observe_on_one_worker worker_;
        rxcpp::composite_subscription notifier_lifetime_;
        rxcpp::subjects::synchronize<Answer, decltype(worker_)> notifier_;
        YacVoteStorage vote_storage_;
        std::shared_ptr<YacNetwork> network_;
        std::shared_ptr<YacCryptoProvider> crypto_;
        std::shared_ptr<Timer> timer_;
      };
    }  // namespace yac
  }    // namespace consensus
}  // namespace iroha

#endif  // IROHA_YAC_HPP