Obsidian
Probabilistic Geophysical Joint Inversion
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
stateline::comms::Minion Class Reference

Minion object that requests a job, computes the result, then submits that result to the connected worker. More...

#include <minion.hpp>

Public Member Functions

 Minion (Worker &w, uint jobID)
 Create a new a minion. More...
 
JobData nextJob ()
 Gets a job from the worker. More...
 
void submitResult (const ResultData &result)
 Submits a result to the worker. Call this function after requesting a job with job(). More...
 

Detailed Description

Minion object that requests a job, computes the result, then submits that result to the connected worker.

Constructor & Destructor Documentation

stateline::comms::Minion::Minion ( Worker w,
uint  jobID 
)

Create a new a minion.

Parameters
wThe parent worker object it communicates with.
jobIDThe ID of the job that the minion will do.

Member Function Documentation

JobData stateline::comms::Minion::nextJob ( )

Gets a job from the worker.

Returns
The job to do.
void stateline::comms::Minion::submitResult ( const ResultData result)

Submits a result to the worker. Call this function after requesting a job with job().

Parameters
resultThe computed result.

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