PMDA++  0.4.4
Header-only C++ library for writing PCP PMDAs
Public Member Functions | Public Attributes | List of all members
pcp::pmda::fetch_value_result Struct Reference

Struct returned by the fetch_value function. More...

#include <pmda.hpp>

Public Member Functions

 fetch_value_result (const pmAtomValue &atom, const int code=PMDA_FETCH_STATIC)
 Constructor. More...
 

Public Attributes

pmAtomValue atom
 Atom value. More...
 
int code
 PMDA fetch code describing atom's memory allocation. More...
 

Detailed Description

Struct returned by the fetch_value function.

See also
pcp::fetch_value

Definition at line 116 of file pmda.hpp.

Constructor & Destructor Documentation

◆ fetch_value_result()

pcp::pmda::fetch_value_result::fetch_value_result ( const pmAtomValue &  atom,
const int  code = PMDA_FETCH_STATIC 
)
inline

Constructor.

Parameters
atomPCP atom value.
codeOptional code to return to PCP. Should be one of the PMDA_FETCH_* constants.

Definition at line 127 of file pmda.hpp.

Member Data Documentation

◆ atom

pmAtomValue pcp::pmda::fetch_value_result::atom

Atom value.

Definition at line 117 of file pmda.hpp.

Referenced by pcp::pmda::on_fetch_callback().

◆ code

int pcp::pmda::fetch_value_result::code

PMDA fetch code describing atom's memory allocation.

Definition at line 118 of file pmda.hpp.

Referenced by pcp::pmda::on_fetch_callback().


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