A group of simulation Peers. More...

#include <PeerGroup.h>

Collaboration diagram for xrpl::test::csf::PeerGroup:

Public Types
using	iterator = peers_type::iterator
using	const_iterator = peers_type::const_iterator
using	reference = peers_type::reference
using	const_reference = peers_type::const_reference

Public Member Functions
	PeerGroup ()=default
	PeerGroup (Peer *peer)
	PeerGroup (std::vector< Peer * > &&peers)
	PeerGroup (std::vector< Peer * > const &peers)
	PeerGroup (std::set< Peer * > const &peers)
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
const_reference	operator[] (std::size_t i) const
bool	contains (Peer const *p)
bool	contains (PeerID id)
std::size_t	size () const
void	trust (PeerGroup const &o)
	Establish trust.
void	untrust (PeerGroup const &o)
	Revoke trust.
void	connect (PeerGroup const &o, SimDuration delay)
	Establish network connection.
void	disconnect (PeerGroup const &o)
	Destroy network connection.
void	trustAndConnect (PeerGroup const &o, SimDuration delay)
	Establish trust and network connection.
void	connectFromTrust (SimDuration delay)
	Establish network connections based on trust relations.

Private Types
using	peers_type = std::vector<Peer*>

Private Attributes
peers_type	peers_

Friends
PeerGroup	operator+ (PeerGroup const &a, PeerGroup const &b)
PeerGroup	operator- (PeerGroup const &a, PeerGroup const &b)
std::ostream &	operator<< (std::ostream &o, PeerGroup const &t)

Detailed Description

A group of simulation Peers.

A PeerGroup is a convenient handle for logically grouping peers together, and then creating trust or network relations for the group at large. Peer groups may also be combined to build out more complex structures.

The PeerGroup provides random access style iterators and operator[]

Definition at line 19 of file PeerGroup.h.

Member Typedef Documentation

◆ peers_type

using xrpl::test::csf::PeerGroup::peers_type = std::vector<Peer*>

private

Definition at line 21 of file PeerGroup.h.

◆ iterator

using xrpl::test::csf::PeerGroup::iterator = peers_type::iterator

Definition at line 25 of file PeerGroup.h.

◆ const_iterator

using xrpl::test::csf::PeerGroup::const_iterator = peers_type::const_iterator

Definition at line 26 of file PeerGroup.h.

◆ reference

using xrpl::test::csf::PeerGroup::reference = peers_type::reference

Definition at line 27 of file PeerGroup.h.

◆ const_reference

using xrpl::test::csf::PeerGroup::const_reference = peers_type::const_reference

Definition at line 28 of file PeerGroup.h.

Constructor & Destructor Documentation

◆ PeerGroup() [1/5]

xrpl::test::csf::PeerGroup::PeerGroup ( )

default

◆ PeerGroup() [2/5]

xrpl::test::csf::PeerGroup::PeerGroup ( Peer * peer )

Definition at line 31 of file PeerGroup.h.

◆ PeerGroup() [3/5]

xrpl::test::csf::PeerGroup::PeerGroup ( std::vector< Peer * > && peers )

Definition at line 34 of file PeerGroup.h.

◆ PeerGroup() [4/5]

xrpl::test::csf::PeerGroup::PeerGroup ( std::vector< Peer * > const & peers )

Definition at line 38 of file PeerGroup.h.

◆ PeerGroup() [5/5]

xrpl::test::csf::PeerGroup::PeerGroup ( std::set< Peer * > const & peers )

Definition at line 43 of file PeerGroup.h.

Member Function Documentation

◆ begin() [1/2]

iterator xrpl::test::csf::PeerGroup::begin ( )

Definition at line 48 of file PeerGroup.h.

◆ end() [1/2]

iterator xrpl::test::csf::PeerGroup::end ( )

Definition at line 54 of file PeerGroup.h.

◆ begin() [2/2]

const_iterator xrpl::test::csf::PeerGroup::begin ( ) const

nodiscard

Definition at line 60 of file PeerGroup.h.

◆ end() [2/2]

const_iterator xrpl::test::csf::PeerGroup::end ( ) const

nodiscard

Definition at line 66 of file PeerGroup.h.

◆ operator[]()

const_reference xrpl::test::csf::PeerGroup::operator[] ( std::size_t i ) const

Definition at line 72 of file PeerGroup.h.

◆ contains() [1/2]

bool xrpl::test::csf::PeerGroup::contains ( Peer const * p )

Definition at line 78 of file PeerGroup.h.

◆ contains() [2/2]

bool xrpl::test::csf::PeerGroup::contains ( PeerID id )

Definition at line 84 of file PeerGroup.h.

◆ size()

std::size_t xrpl::test::csf::PeerGroup::size ( ) const

nodiscard

Definition at line 91 of file PeerGroup.h.

◆ trust()

void xrpl::test::csf::PeerGroup::trust ( PeerGroup const & o )

Establish trust.

Establish trust from all peers in this group to all peers in o

Parameters

o	The group of peers to trust

Definition at line 103 of file PeerGroup.h.

◆ untrust()

void xrpl::test::csf::PeerGroup::untrust ( PeerGroup const & o )

Revoke trust.

Revoke trust from all peers in this group to all peers in o

Parameters

o	The group of peers to untrust

Definition at line 121 of file PeerGroup.h.

◆ connect()

void xrpl::test::csf::PeerGroup::connect	(	PeerGroup const &	o,
		SimDuration	delay )

Establish network connection.

Establish outbound connections from all peers in this group to all peers in o. If a connection already exists, no new connection is established.

Parameters

o	The group of peers to connect to (will get inbound connections)
delay	The fixed messaging delay for all established connections

Definition at line 143 of file PeerGroup.h.

◆ disconnect()

void xrpl::test::csf::PeerGroup::disconnect ( PeerGroup const & o )

Destroy network connection.

Destroy connections from all peers in this group to all peers in o

Parameters

o	The group of peers to disconnect from

Definition at line 163 of file PeerGroup.h.

◆ trustAndConnect()

void xrpl::test::csf::PeerGroup::trustAndConnect	(	PeerGroup const &	o,
		SimDuration	delay )

Establish trust and network connection.

Establish trust and create a network connection with fixed delay from all peers in this group to all peers in o

Parameters

o	The group of peers to trust and connect to
delay	The fixed messaging delay for all established connections

Definition at line 183 of file PeerGroup.h.

◆ connectFromTrust()

void xrpl::test::csf::PeerGroup::connectFromTrust ( SimDuration delay )

Establish network connections based on trust relations.

For each peers in this group, create outbound network connection to the set of peers it trusts. If a connection already exists, it is not recreated.

Parameters

delay The fixed messaging delay for all established connections

Definition at line 199 of file PeerGroup.h.

◆ operator+

PeerGroup operator+	(	PeerGroup const &	a,
		PeerGroup const &	b )

friend

Definition at line 212 of file PeerGroup.h.

◆ operator-

PeerGroup operator-	(	PeerGroup const &	a,
		PeerGroup const &	b )

friend

Definition at line 221 of file PeerGroup.h.

◆ operator<<

std::ostream & operator<<	(	std::ostream &	o,
		PeerGroup const &	t )

friend

Definition at line 230 of file PeerGroup.h.

Member Data Documentation

◆ peers_

peers_type xrpl::test::csf::PeerGroup::peers_

private

Definition at line 22 of file PeerGroup.h.

Public Types

Public Member Functions

Private Types

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ peers_type

◆ iterator

◆ const_iterator

◆ reference

◆ const_reference

Constructor & Destructor Documentation

◆ PeerGroup() [1/5]

◆ PeerGroup() [2/5]

◆ PeerGroup() [3/5]

◆ PeerGroup() [4/5]

◆ PeerGroup() [5/5]

Member Function Documentation

◆ begin() [1/2]

◆ end() [1/2]

◆ begin() [2/2]

◆ end() [2/2]

◆ operator[]()

◆ contains() [1/2]

◆ contains() [2/2]

◆ size()

◆ trust()

◆ untrust()

◆ connect()

◆ disconnect()

◆ trustAndConnect()

◆ connectFromTrust()

Friends And Related Symbol Documentation

◆ operator+

◆ operator-

◆ operator<<

Member Data Documentation

◆ peers_