MUQ  0.4.3
Public Member Functions | List of all members
muq::SamplingAlgorithms::PhonebookClient Class Reference

High-level wrapper for communicating with the phonebook process. More...

#include <Phonebook.h>

Detailed Description

High-level wrapper for communicating with the phonebook process.

This wraps communication with the phonebook in an easy to use interface. Needed for example by sampling worker processes to announce when samples are available to be collected.

Definition at line 393 of file Phonebook.h.

Public Member Functions

 PhonebookClient (std::shared_ptr< parcer::Communicator > comm, int phonebookRank)
 
int Query (std::shared_ptr< MultiIndex > remoteIndex, std::shared_ptr< MultiIndex > sourceIndex, bool high_priority)
 
std::vector< int > GetWorkgroups (std::shared_ptr< MultiIndex > modelIndex)
 
std::shared_ptr< MultiIndex > LargestIndex ()
 
void Register (std::shared_ptr< MultiIndex > modelIndex, int rank)
 
void UnRegister (std::shared_ptr< MultiIndex > modelIndex, int rank)
 
void SetWorkerReady (std::shared_ptr< MultiIndex > modelIndex, int rank)
 
void SchedulingDone ()
 
void SchedulingStop ()
 

Constructor & Destructor Documentation

◆ PhonebookClient()

muq::SamplingAlgorithms::PhonebookClient::PhonebookClient ( std::shared_ptr< parcer::Communicator >  comm,
int  phonebookRank 
)
inline

Definition at line 397 of file Phonebook.h.

Member Function Documentation

◆ GetWorkgroups()

std::vector<int> muq::SamplingAlgorithms::PhonebookClient::GetWorkgroups ( std::shared_ptr< MultiIndex >  modelIndex)
inline

Definition at line 410 of file Phonebook.h.

References comm, muq::SamplingAlgorithms::ControlTag, muq::SamplingAlgorithms::GET_WORKGROUPS, and phonebookRank.

◆ LargestIndex()

std::shared_ptr<MultiIndex> muq::SamplingAlgorithms::PhonebookClient::LargestIndex ( )
inline

Definition at line 420 of file Phonebook.h.

References comm, muq::SamplingAlgorithms::ControlTag, muq::SamplingAlgorithms::GET_LARGEST_INDEX, and phonebookRank.

◆ Query()

int muq::SamplingAlgorithms::PhonebookClient::Query ( std::shared_ptr< MultiIndex >  remoteIndex,
std::shared_ptr< MultiIndex >  sourceIndex,
bool  high_priority 
)
inline

Definition at line 402 of file Phonebook.h.

References comm, muq::SamplingAlgorithms::ControlTag, muq::SamplingAlgorithms::GET_WORKGROUP, and phonebookRank.

◆ Register()

void muq::SamplingAlgorithms::PhonebookClient::Register ( std::shared_ptr< MultiIndex >  modelIndex,
int  rank 
)
inline

Definition at line 425 of file Phonebook.h.

References comm, muq::SamplingAlgorithms::ControlTag, phonebookRank, and muq::SamplingAlgorithms::SET_WORKGROUP.

◆ SchedulingDone()

void muq::SamplingAlgorithms::PhonebookClient::SchedulingDone ( )
inline

Definition at line 445 of file Phonebook.h.

References comm, muq::SamplingAlgorithms::ControlTag, phonebookRank, and muq::SamplingAlgorithms::SCHEDULING_DONE.

◆ SchedulingStop()

void muq::SamplingAlgorithms::PhonebookClient::SchedulingStop ( )
inline

Definition at line 448 of file Phonebook.h.

References comm, muq::SamplingAlgorithms::ControlTag, phonebookRank, and muq::SamplingAlgorithms::SCHEDULING_STOP.

◆ SetWorkerReady()

void muq::SamplingAlgorithms::PhonebookClient::SetWorkerReady ( std::shared_ptr< MultiIndex >  modelIndex,
int  rank 
)
inline

Definition at line 439 of file Phonebook.h.

References comm, muq::SamplingAlgorithms::ControlTag, phonebookRank, and muq::SamplingAlgorithms::SET_WORKER_READY.

◆ UnRegister()

void muq::SamplingAlgorithms::PhonebookClient::UnRegister ( std::shared_ptr< MultiIndex >  modelIndex,
int  rank 
)
inline

Definition at line 431 of file Phonebook.h.

References comm, muq::SamplingAlgorithms::ControlTag, phonebookRank, and muq::SamplingAlgorithms::UNSET_WORKGROUP.

Member Data Documentation

◆ comm

std::shared_ptr<parcer::Communicator> muq::SamplingAlgorithms::PhonebookClient::comm
private

Definition at line 453 of file Phonebook.h.

Referenced by GetWorkgroups(), LargestIndex(), Query(), Register(), SchedulingDone(), SchedulingStop(), SetWorkerReady(), and UnRegister().

◆ phonebookRank

int muq::SamplingAlgorithms::PhonebookClient::phonebookRank
private

Definition at line 454 of file Phonebook.h.

Referenced by GetWorkgroups(), LargestIndex(), Query(), Register(), SchedulingDone(), SchedulingStop(), SetWorkerReady(), and UnRegister().

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