iroha::consensus::yac::ClusterOrdering Class Reference

#include "cluster_order.hpp"

Collaboration diagram for iroha::consensus::yac::ClusterOrdering:

Public Member Functions
const shared_model::interface::Peer &	currentLeader ()
ClusterOrdering &	switchToNext ()
bool	hasNext () const
const shared_model::interface::types::PeerList &	getPeers () const
PeersNumberType	getNumberOfPeers () const
virtual	~ClusterOrdering ()=default
	ClusterOrdering ()=delete

Static Public Member Functions
static std::optional< ClusterOrdering >	create (std::vector< std::shared_ptr< shared_model::interface::Peer >> const &order, std::vector< size_t > const &peer_positions)
static std::optional< ClusterOrdering >	create (std::vector< std::shared_ptr< shared_model::interface::Peer >> const &order)

Detailed Description

Class provide ordering on cluster for current round

Constructor & Destructor Documentation

~ClusterOrdering()

virtual iroha::consensus::yac::ClusterOrdering::~ClusterOrdering ( )

virtualdefault

ClusterOrdering()

iroha::consensus::yac::ClusterOrdering::ClusterOrdering ( )

delete

Here is the caller graph for this function:

Member Function Documentation

create() [1/2]

std::optional< ClusterOrdering > ClusterOrdering::create ( std::vector< std::shared_ptr< shared_model::interface::Peer >> const &  order, std::vector< size_t > const &  peer_positions  )

static

Creates cluster ordering from the vector of peers and peer positions

Parameters

order	vector of peers
peer_positions	vector of indexes of peer positions

Returns

ClusterOrdering if vectors are not empty, null otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

create() [2/2]

std::optional< ClusterOrdering > ClusterOrdering::create ( std::vector< std::shared_ptr< shared_model::interface::Peer >> const &  order )

static

Creates cluster ordering from the vector of peers

Parameters

order

vector of peers

Returns

ClusterOrdering if vectors are not empty, null otherwise

Here is the call graph for this function:

currentLeader()

const shared_model::interface::Peer & ClusterOrdering::currentLeader

(

)

Provide current leader peer

Here is the caller graph for this function:

getNumberOfPeers()

size_t ClusterOrdering::getNumberOfPeers

(

)

const

getPeers()

const shared_model::interface::types::PeerList & ClusterOrdering::getPeers

(

)

const

Here is the caller graph for this function:

hasNext()

bool ClusterOrdering::hasNext

(

)

const

Returns

true if current leader not last peer in order

switchToNext()

ClusterOrdering & ClusterOrdering::switchToNext

(

)

Switch to next peer as leader

Returns

this

Here is the caller graph for this function:

---

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

• irohad/consensus/yac/cluster_order.hpp
• irohad/consensus/yac/impl/cluster_order.cpp