Zero Module Framework  1.0
A framework for running distributed modules using a ZMQ message bus
 All Classes Namespaces Files Functions Variables Friends Macros
Public Member Functions | List of all members
zmf::discovery::IPeerDiscoveryService Class Referenceabstract

#include <IPeerDiscoveryService.hpp>

Inheritance diagram for zmf::discovery::IPeerDiscoveryService:
zmf::discovery::PeerDiscoveryService

Public Member Functions

virtual bool start (std::shared_ptr< config::IConfigurationProvider > config, IPeerDiscoveryCoreInterface *const core, std::shared_ptr< zmf::data::ModuleHandle > selfHandle, uint32_t multicastFrequency, uint16_t udpPort, bool peerDiscoveryWait, bool disableEqualModuleInterconnect)=0
 
virtual void stop ()=0
 
virtual void sendStateMulticast ()=0
 
virtual const std::shared_ptr
< zmf::discovery::PeerRegistry > & 		getPeerRegistry ()=0
 
virtual void updateSelfState (zmf::data::ModuleState state)=0
 
virtual void updateSelfAdditionalState (std::vector< uint8_t > additionalState)=0
 

Detailed Description

Interface to access the PeerDiscoveryService - Service class to recognize other modules and there states in the network. PeerStates can be accessed via PeerRegistry (getPeerRegistry)

Author
Jonas Grunert
Date
created on 7/7/15.

Member Function Documentation

virtual const std::shared_ptr<zmf::discovery::PeerRegistry>& zmf::discovery::IPeerDiscoveryService::getPeerRegistry ( )
pure virtual
Returns
Peer registry where all known active peers are registered

Implemented in zmf::discovery::PeerDiscoveryService.

virtual void zmf::discovery::IPeerDiscoveryService::sendStateMulticast ( )
pure virtual

Forces a broadcast when a module was changed

Implemented in zmf::discovery::PeerDiscoveryService.

virtual bool zmf::discovery::IPeerDiscoveryService::start ( std::shared_ptr< config::IConfigurationProvider >  config,
IPeerDiscoveryCoreInterface *const  core,
std::shared_ptr< zmf::data::ModuleHandle >  selfHandle,
uint32_t  multicastFrequency,
uint16_t  udpPort,
bool  peerDiscoveryWait,
bool  disableEqualModuleInterconnect 
)
pure virtual

Starts the peer discovery service: State broadcasting, peer discovery and module registry.

Parameters
coreReference to the ZMF core
selfHandleModule handle for the module of this instance. Contains information about module and its state
broadcastFrequencyFrequency to send out state broadcasts (in milliseconds between broadcasts)
udpPortUDP port for state broadcast communication
trackModuleStatesFlag to enable/disable tracking of module states. If disabled only module leave and join will be tracked
Returns
Returns true if start successful, false otherwise

Implemented in zmf::discovery::PeerDiscoveryService.

virtual void zmf::discovery::IPeerDiscoveryService::stop ( )
pure virtual

Implemented in zmf::discovery::PeerDiscoveryService.

virtual void zmf::discovery::IPeerDiscoveryService::updateSelfAdditionalState ( std::vector< uint8_t >  additionalState)
pure virtual

Implemented in zmf::discovery::PeerDiscoveryService.

virtual void zmf::discovery::IPeerDiscoveryService::updateSelfState ( zmf::data::ModuleState  state)
pure virtual

Implemented in zmf::discovery::PeerDiscoveryService.

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