<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Open SCAP Library: oval_agent_api.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Open SCAP Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_dec16e0beb5f79ab6b40e328203e2e32.html">OVAL</a></li><li class="navelem"><a class="el" href="dir_d7d4c5e9309fab4992a34dcb057ec544.html">public</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">oval_agent_api.h File Reference<div class="ingroups"><a class="el" href="group__OVALAGENT.html">OVAL Agent</a></div></div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="oval__definitions_8h_source.html">oval_definitions.h</a>"</code><br/>
<code>#include "<a class="el" href="oval__system__characteristics_8h_source.html">oval_system_characteristics.h</a>"</code><br/>
<code>#include "<a class="el" href="oval__results_8h_source.html">oval_results.h</a>"</code><br/>
<code>#include "<a class="el" href="oval__variables_8h_source.html">oval_variables.h</a>"</code><br/>
<code>#include "<a class="el" href="oval__probe_8h_source.html">oval_probe.h</a>"</code><br/>
</div>
<p><a href="oval__agent__api_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga7c852f3681ee4aaf6d372facf2e8c016"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7c852f3681ee4aaf6d372facf2e8c016"></a>
typedef struct <a class="el" href="structoval__agent__session.html">oval_agent_session</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">oval_agent_session_t</a></td></tr>
<tr class="memdesc:ga7c852f3681ee4aaf6d372facf2e8c016"><td class="mdescLeft"> </td><td class="mdescRight">Agent session consists of connection to system checking engine, definition model, system characteristics model and results model. <br/></td></tr>
<tr class="separator:ga7c852f3681ee4aaf6d372facf2e8c016"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga24d36c3c4be540ce08253abb69c4b842"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga24d36c3c4be540ce08253abb69c4b842"></a>
typedef int(* </td><td class="memItemRight" valign="bottom"><b>agent_reporter</b> )(const struct <a class="el" href="structoval__result__definition.html">oval_result_definition</a> *res_def, void *arg)</td></tr>
<tr class="separator:ga24d36c3c4be540ce08253abb69c4b842"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga363376feb3dc45839611dbf7ae149934"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">oval_agent_session_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga363376feb3dc45839611dbf7ae149934">oval_agent_new_session</a> (struct <a class="el" href="structoval__definition__model.html">oval_definition_model</a> *model, const char *name)</td></tr>
<tr class="memdesc:ga363376feb3dc45839611dbf7ae149934"><td class="mdescLeft"> </td><td class="mdescRight">Create new session for OVAL agent from OVAL definition model. <a href="group__OVALAGENT.html#ga363376feb3dc45839611dbf7ae149934">More...</a><br/></td></tr>
<tr class="separator:ga363376feb3dc45839611dbf7ae149934"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5356ae518e8f7944d7c4e4a4d6320c79"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5356ae518e8f7944d7c4e4a4d6320c79"></a>
struct <a class="el" href="structoval__definition__model.html">oval_definition_model</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga5356ae518e8f7944d7c4e4a4d6320c79">oval_agent_get_definition_model</a> (<a class="el" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">oval_agent_session_t</a> *ag_sess)</td></tr>
<tr class="memdesc:ga5356ae518e8f7944d7c4e4a4d6320c79"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves OVAL definition model associated with given session. <br/></td></tr>
<tr class="separator:ga5356ae518e8f7944d7c4e4a4d6320c79"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4c6cd8133b213a14271d61c1058801c8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga4c6cd8133b213a14271d61c1058801c8">oval_agent_set_product_name</a> (<a class="el" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">oval_agent_session_t</a> *, char *)</td></tr>
<tr class="memdesc:ga4c6cd8133b213a14271d61c1058801c8"><td class="mdescLeft"> </td><td class="mdescRight">Set a product name for the provided agent session. <a href="group__OVALAGENT.html#ga4c6cd8133b213a14271d61c1058801c8">More...</a><br/></td></tr>
<tr class="separator:ga4c6cd8133b213a14271d61c1058801c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf73eb2fb4162b9293f166ea02dd889ab"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#gaf73eb2fb4162b9293f166ea02dd889ab">oval_agent_eval_definition</a> (<a class="el" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">oval_agent_session_t</a> *, const char *)</td></tr>
<tr class="memdesc:gaf73eb2fb4162b9293f166ea02dd889ab"><td class="mdescLeft"> </td><td class="mdescRight">Probe the system and evaluate specified definition. <a href="group__OVALAGENT.html#gaf73eb2fb4162b9293f166ea02dd889ab">More...</a><br/></td></tr>
<tr class="separator:gaf73eb2fb4162b9293f166ea02dd889ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9a88f1166593f63aa0f7cdc080685c1d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga9a88f1166593f63aa0f7cdc080685c1d">oval_agent_get_definition_result</a> (<a class="el" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">oval_agent_session_t</a> *, const char *, <a class="el" href="group__OVALRES.html#ga585abe0825db03426e1994ba335dc4bf">oval_result_t</a> *)</td></tr>
<tr class="memdesc:ga9a88f1166593f63aa0f7cdc080685c1d"><td class="mdescLeft"> </td><td class="mdescRight">Get the OVAL result of a definition from an agent session. <a href="group__OVALAGENT.html#ga9a88f1166593f63aa0f7cdc080685c1d">More...</a><br/></td></tr>
<tr class="separator:ga9a88f1166593f63aa0f7cdc080685c1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga59b66b81fe4d2aedfe1255420fab709a"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__result__definition.html">oval_result_definition</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga59b66b81fe4d2aedfe1255420fab709a">oval_agent_get_result_definition</a> (<a class="el" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">oval_agent_session_t</a> *ag_sess, const char *id)</td></tr>
<tr class="memdesc:ga59b66b81fe4d2aedfe1255420fab709a"><td class="mdescLeft"> </td><td class="mdescRight">Get the OVAL result definition from an agent session. <a href="group__OVALAGENT.html#ga59b66b81fe4d2aedfe1255420fab709a">More...</a><br/></td></tr>
<tr class="separator:ga59b66b81fe4d2aedfe1255420fab709a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1b0b775e52aff1452ff4423f897c5825"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1b0b775e52aff1452ff4423f897c5825"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga1b0b775e52aff1452ff4423f897c5825">oval_agent_reset_session</a> (<a class="el" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">oval_agent_session_t</a> *ag_sess)</td></tr>
<tr class="memdesc:ga1b0b775e52aff1452ff4423f897c5825"><td class="mdescLeft"> </td><td class="mdescRight">Clean resuls that were generated in this agent session. <br/></td></tr>
<tr class="separator:ga1b0b775e52aff1452ff4423f897c5825"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7b465c077aa0ade17135dc1826b4465c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7b465c077aa0ade17135dc1826b4465c"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga7b465c077aa0ade17135dc1826b4465c">oval_agent_abort_session</a> (<a class="el" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">oval_agent_session_t</a> *ag_sess)</td></tr>
<tr class="memdesc:ga7b465c077aa0ade17135dc1826b4465c"><td class="mdescLeft"> </td><td class="mdescRight">Abort a running probe session. <br/></td></tr>
<tr class="separator:ga7b465c077aa0ade17135dc1826b4465c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4e56e46262872dea08c12cf9fdf10d74"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga4e56e46262872dea08c12cf9fdf10d74">oval_agent_eval_system</a> (<a class="el" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">oval_agent_session_t</a> *ag_sess, agent_reporter cb, void *arg)</td></tr>
<tr class="memdesc:ga4e56e46262872dea08c12cf9fdf10d74"><td class="mdescLeft"> </td><td class="mdescRight">Probe and evaluate all definitions from the content, call the callback functions upon single evaluation. <a href="group__OVALAGENT.html#ga4e56e46262872dea08c12cf9fdf10d74">More...</a><br/></td></tr>
<tr class="separator:ga4e56e46262872dea08c12cf9fdf10d74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga46b7afeb2b281141e4722f219a7a438a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga46b7afeb2b281141e4722f219a7a438a"></a>
struct <a class="el" href="structoval__results__model.html">oval_results_model</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga46b7afeb2b281141e4722f219a7a438a">oval_agent_get_results_model</a> (<a class="el" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">oval_agent_session_t</a> *ag_sess)</td></tr>
<tr class="memdesc:ga46b7afeb2b281141e4722f219a7a438a"><td class="mdescLeft"> </td><td class="mdescRight">Get a result model from agent session. <br/></td></tr>
<tr class="separator:ga46b7afeb2b281141e4722f219a7a438a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga891f69cec678e572518603f482e54877"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga891f69cec678e572518603f482e54877"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga891f69cec678e572518603f482e54877">oval_agent_get_filename</a> (<a class="el" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">oval_agent_session_t</a> *ag_sess)</td></tr>
<tr class="memdesc:ga891f69cec678e572518603f482e54877"><td class="mdescLeft"> </td><td class="mdescRight">Get a filename under which was created. <br/></td></tr>
<tr class="separator:ga891f69cec678e572518603f482e54877"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga301f466948c1844837208f917b3e2025"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga301f466948c1844837208f917b3e2025"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga301f466948c1844837208f917b3e2025">oval_agent_destroy_session</a> (<a class="el" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">oval_agent_session_t</a> *ag_sess)</td></tr>
<tr class="memdesc:ga301f466948c1844837208f917b3e2025"><td class="mdescLeft"> </td><td class="mdescRight">Finish OVAL agent session. <br/></td></tr>
<tr class="separator:ga301f466948c1844837208f917b3e2025"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>"David Niemoller" <a href="#" onclick="location.href='mai'+'lto:'+'Dav'+'id'+'.Ni'+'em'+'oll'+'er'+'@g2'+'-i'+'nc.'+'co'+'m'; return false;">David<span style="display: none;">.nosp@m.</span>.Nie<span style="display: none;">.nosp@m.</span>molle<span style="display: none;">.nosp@m.</span>r@g2<span style="display: none;">.nosp@m.</span>-inc.<span style="display: none;">.nosp@m.</span>com</a> </dd>
<dd>
"Peter Vrabec" <a href="#" onclick="location.href='mai'+'lto:'+'pvr'+'ab'+'ec@'+'gm'+'ail'+'.c'+'om'; return false;">pvrab<span style="display: none;">.nosp@m.</span>ec@g<span style="display: none;">.nosp@m.</span>mail.<span style="display: none;">.nosp@m.</span>com</a> </dd></dl>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
distrib
>
Scientific%20Linux
>
5x
>
x86_64
>
by-pkgid
>
dcbb19bbc4636f73f405fbb232b0cc34
>
files
>
313
