Struct VJouleAPI

pub struct VJouleAPI {}

Main element of the vjoule api

Implementations

impl VJouleAPI

pub fn new() -> Result<VJouleAPI, VJouleError>

Create and configure the vjoule api Create a this process_group refering to the pid of the current process (and all its threads / forks) To work properly the vjoule service has to be running

Example

let mut api = VJouleAPI::new ()?;
let machine_conso = api.get_current_machine_consumption ()?;

println!("Current machine consumption : {}", machine_conso);

Returns

• On success, the vjoule api
• On error, a message explaining the error

pub fn get_current_machine_consumption( &mut self, ) -> Result<ConsumptionStamp, VJouleError>

Returns

The consumption of the machine since the start of the vjoule service

Information

This function make sure the vjoule service has written a consumption before returning. It forces the service to perform an iteration to avoid waiting too long, but it can take a bit of time (some milliseconds).

pub fn get_current_machine_consumption_no_force( &mut self, ) -> Result<ConsumptionStamp, VJouleError>

Returns

The consumption of the machine since the start of the vjoule service