fawkes::GossipGroupManager Class Reference

Abstract class for a Gossip group manager. More...

#include <>>

Public Member Functions
	GossipGroupManager (std::string &service_name, ServicePublisher *service_publisher, std::map< std::string, GossipGroupConfiguration > &initial_groups)
	Constructor. More...
virtual	~GossipGroupManager ()
	Destructor. More...
virtual RefPtr< GossipGroup >	join_group (const std::string &name)
	Join a group. More...
virtual void	leave_group (RefPtr< GossipGroup > &group)
	Leave a gossip group. More...

Detailed Description

Abstract class for a Gossip group manager.

Author

Tim Niemueller

Definition at line 62 of file gossip_group_manager.h.

Constructor & Destructor Documentation

GossipGroupManager()

fawkes::GossipGroupManager::GossipGroupManager	(	std::string &	service_name,
		ServicePublisher *	service_publisher,
		std::map< std::string, GossipGroupConfiguration > &	initial_groups
	)

Constructor.

Parameters

service_name	service name to announce for each group we join, this must be unique in the group and should identify the robot
service_publisher	service discovery publisher to announce groups
initial_groups	initial group configurations to join

Definition at line 108 of file gossip_group_manager.cpp.

~GossipGroupManager()

fawkes::GossipGroupManager::~GossipGroupManager ( )

virtual

Destructor.

Definition at line 127 of file gossip_group_manager.cpp.

Member Function Documentation

join_group()

fawkes::RefPtr< fawkes::GossipGroup > fawkes::GossipGroupManager::join_group ( const std::string &  name )

virtual

Join a group.

Parameters

name	the name of the group to join

Returns

a shared object to communicate with the group.

Definition at line 136 of file gossip_group_manager.cpp.

Referenced by fawkes::GossipAspectIniFin::init().

leave_group()

void fawkes::GossipGroupManager::leave_group ( RefPtr< GossipGroup > &  group )

virtual

Leave a gossip group.

Parameters

group

the gossip group to leave, the handle becomes invalid after this call.

Definition at line 154 of file gossip_group_manager.cpp.

References fawkes::RefPtr< T_CppObject >::reset().

Referenced by fawkes::GossipAspectIniFin::finalize().

---

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

• src/plugins/gossip/gossip/gossip_group_manager.h
• src/plugins/gossip/gossip/gossip_group_manager.cpp