geopm  3.1.1.dev296+g5916b956
GEOPM - Global Extensible Open Power Manager
Public Member Functions | Static Public Member Functions | List of all members
geopm::Daemon Class Referenceabstract

#include <Daemon.hpp>

Inheritance diagram for geopm::Daemon:
Inheritance graph
[legend]

Public Member Functions

virtual ~Daemon ()=default
 
virtual void update_endpoint_from_policystore (double timeout)=0
 Looks up a policy in the Daemon's PolicyStore given the attached Controller's agent and profile name, and writes it back into the policy side of the Daemon's Endpoint. If no policy is found, an error is returned. If the Controller fails to attach within the timeout , or detaches while this function is running, no policy is written. More...
 
virtual void stop_wait_loop (void)=0
 Exits early from any ongoing wait loops in the Daemon, for example in a call to update_endpoint_from_policystore(). More...
 
virtual void reset_wait_loop (void)=0
 Resets the Daemon's endpoint to prepare for a future wait loop. More...
 

Static Public Member Functions

static std::unique_ptr< Daemonmake_unique (const std::string &endpoint_name, const std::string &db_path)
 

Detailed Description

Methods using the Endpoint interface in combination with other utilities to perform some system admin functions.

Constructor & Destructor Documentation

◆ ~Daemon()

virtual geopm::Daemon::~Daemon ( )
virtualdefault

Member Function Documentation

◆ make_unique()

std::unique_ptr< Daemon > geopm::Daemon::make_unique ( const std::string &  endpoint_name,
const std::string &  db_path 
)
static
Parameters
endpoint_nameThe shared memory prefix for the Endpoint
db_pathThe path to the PolicyStore
Returns
unique_ptr<Daemon> to a concrete DaemonImp object.

◆ reset_wait_loop()

virtual void geopm::Daemon::reset_wait_loop ( void  )
pure virtual

Resets the Daemon's endpoint to prepare for a future wait loop.

Implemented in geopm::DaemonImp.

◆ stop_wait_loop()

virtual void geopm::Daemon::stop_wait_loop ( void  )
pure virtual

Exits early from any ongoing wait loops in the Daemon, for example in a call to update_endpoint_from_policystore().

Implemented in geopm::DaemonImp.

◆ update_endpoint_from_policystore()

virtual void geopm::Daemon::update_endpoint_from_policystore ( double  timeout)
pure virtual

Looks up a policy in the Daemon's PolicyStore given the attached Controller's agent and profile name, and writes it back into the policy side of the Daemon's Endpoint. If no policy is found, an error is returned. If the Controller fails to attach within the timeout , or detaches while this function is running, no policy is written.

Parameters
timeoutRange of time within which the Controller must attach.

Implemented in geopm::DaemonImp.


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