iroha::ordering::ProposalCreationStrategy Class Reference

#include "ordering_service_proposal_creation_strategy.hpp"

Inheritance diagram for iroha::ordering::ProposalCreationStrategy:

Collaboration diagram for iroha::ordering::ProposalCreationStrategy:

Public Types
using	RoundType = consensus::Round
	shortcut for round type More...

Public Member Functions
virtual void	onCollaborationOutcome (RoundType round, size_t peers_in_round)=0
virtual bool	shouldCreateRound (RoundType round)=0
virtual boost::optional< RoundType >	onProposalRequest (RoundType requested_round)=0
virtual	~ProposalCreationStrategy ()=default

Detailed Description

Class provides a strategy for creation proposals regarding to new rounds and requests from other peers

Member Typedef Documentation

RoundType

using iroha::ordering::ProposalCreationStrategy::RoundType = consensus::Round

shortcut for round type

Constructor & Destructor Documentation

~ProposalCreationStrategy()

virtual iroha::ordering::ProposalCreationStrategy::~ProposalCreationStrategy ( )

virtualdefault

Member Function Documentation

onCollaborationOutcome()

virtual void iroha::ordering::ProposalCreationStrategy::onCollaborationOutcome ( RoundType  round, size_t  peers_in_round  )

pure virtual

Indicates the start of new round.

Parameters

round	- proposal round which has started
peers_in_round	- peers which participate in new round

Implemented in iroha::ordering::KickOutProposalCreationStrategy.

onProposalRequest()

virtual boost::optional<RoundType> iroha::ordering::ProposalCreationStrategy::onProposalRequest ( RoundType  requested_round )

pure virtual

Notify the strategy about proposal request

Parameters

requested_round

- in which round proposal is requested

Returns

round where proposal is required to be created immediately

Implemented in iroha::ordering::KickOutProposalCreationStrategy.

shouldCreateRound()

virtual bool iroha::ordering::ProposalCreationStrategy::shouldCreateRound ( RoundType  round )

pure virtual

Parameters

round

- new consensus round

Returns

true, if proposal should be created in the new round

Implemented in iroha::ordering::KickOutProposalCreationStrategy.

---

The documentation for this class was generated from the following file:

• irohad/ordering/ordering_service_proposal_creation_strategy.hpp