<!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"/>
<title>Open SCAP Library: Probe session API</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<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>
<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><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">Probe session API</div> </div>
<div class="ingroups"><a class="el" href="group__PROBES.html">System checking mechanism - probes</a></div></div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structoval__probe__session.html">oval_probe_session</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">OVAL probe session structure. <a href="structoval__probe__session.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga295f5308d30c7e491f9fa9ba3f408431"></a><!-- doxytag: member="PROBESESSION::oval_probe_session_t" ref="ga295f5308d30c7e491f9fa9ba3f408431" args="" -->
typedef struct <a class="el" href="structoval__probe__session.html">oval_probe_session</a> </td><td class="memItemRight" valign="bottom"><b>oval_probe_session_t</b></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBESESSION.html#ga89df3c24436ed2a50770b4e00f81e525">oval_probe_session_new</a> (struct <a class="el" href="structoval__syschar__model.html">oval_syschar_model</a> *model)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create and initialize a new probe session. <a href="#ga89df3c24436ed2a50770b4e00f81e525"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBESESSION.html#ga570a8ec1ddefa3dea49b75b7ba430d82">oval_probe_session_destroy</a> (<a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *sess)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy probe session. <a href="#ga570a8ec1ddefa3dea49b75b7ba430d82"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBESESSION.html#ga7875c98b154cb7b574d500920a5da432">oval_probe_session_close</a> (<a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *sess)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a close request to all probes. <a href="#ga7875c98b154cb7b574d500920a5da432"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBESESSION.html#ga12311e1f51159191021c24f5663925a9">oval_probe_session_reset</a> (<a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *sess, struct <a class="el" href="structoval__syschar__model.html">oval_syschar_model</a> *sysch)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the session. <a href="#ga12311e1f51159191021c24f5663925a9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga15b2a32e07b0affdb2d263f2a6f83fbf"></a><!-- doxytag: member="PROBESESSION::oval_probe_session_abort" ref="ga15b2a32e07b0affdb2d263f2a6f83fbf" args="(oval_probe_session_t *sess)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBESESSION.html#ga15b2a32e07b0affdb2d263f2a6f83fbf">oval_probe_session_abort</a> (<a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *sess)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Abort the session. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBESESSION.html#gaeaad2407d22a2865ff7bca1e4dec2bc9">oval_probe_session_sethandler</a> (<a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *sess, <a class="el" href="group__OVAL.html#ga99498f525c1a0282ef45557fc882f97f">oval_subtype_t</a> type, <a class="el" href="group__PROBEHANDLERS.html#gaa9dc58a25b744ead912c84a69bab84b6">oval_probe_handler_t</a> handler, void *ptr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a new handler for an object of the specified type. <a href="#gaeaad2407d22a2865ff7bca1e4dec2bc9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__syschar__model.html">oval_syschar_model</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBESESSION.html#ga2ed62b62d886e985c9228d76fbee6150">oval_probe_session_getmodel</a> (<a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> *sess)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get system characteristics model from probe session. <a href="#ga2ed62b62d886e985c9228d76fbee6150"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1d3383910bd9e1ed87a83c121f4175dd"></a><!-- doxytag: member="PROBESESSION::pext" ref="ga1d3383910bd9e1ed87a83c121f4175dd" args="" -->
void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBESESSION.html#ga1d3383910bd9e1ed87a83c121f4175dd">oval_probe_session::pext</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">dummy pointer <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabd631014ee2350816f4636620c9c0ed2"></a><!-- doxytag: member="PROBESESSION::sys_model" ref="gabd631014ee2350816f4636620c9c0ed2" args="" -->
struct <a class="el" href="structoval__syschar__model.html">oval_syschar_model</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBESESSION.html#gabd631014ee2350816f4636620c9c0ed2">oval_probe_session::sys_model</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">system characteristics model <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2b3f6d54e3ad513c29e44d0bd846b6d1"></a><!-- doxytag: member="PROBESESSION::dir" ref="ga2b3f6d54e3ad513c29e44d0bd846b6d1" args="" -->
char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBESESSION.html#ga2b3f6d54e3ad513c29e44d0bd846b6d1">oval_probe_session::dir</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">probe session directory <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa77ed7a3b41c83ce37d3b2a15ff8b78f"></a><!-- doxytag: member="PROBESESSION::flg" ref="gaa77ed7a3b41c83ce37d3b2a15ff8b78f" args="" -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROBESESSION.html#gaa77ed7a3b41c83ce37d3b2a15ff8b78f">oval_probe_session::flg</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">probe session flags <br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga7875c98b154cb7b574d500920a5da432"></a><!-- doxytag: member="oval_probe_session.c::oval_probe_session_close" ref="ga7875c98b154cb7b574d500920a5da432" args="(oval_probe_session_t *sess)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oval_probe_session_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> * </td>
<td class="paramname"><em>sess</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send a close request to all probes. </p>
<p>In case of external probes, the running processes are shutdown - all cached results are lost. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sess</td><td>pointer to the probe session structure </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga570a8ec1ddefa3dea49b75b7ba430d82"></a><!-- doxytag: member="oval_probe_session.c::oval_probe_session_destroy" ref="ga570a8ec1ddefa3dea49b75b7ba430d82" args="(oval_probe_session_t *sess)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oval_probe_session_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> * </td>
<td class="paramname"><em>sess</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy probe session. </p>
<p>All state information created during the lifetime of the session is freed, resources used by probes are freed using the probe handler API. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sess</td><td>pointer to the probe session structure </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga2ed62b62d886e985c9228d76fbee6150"></a><!-- doxytag: member="oval_probe_session.c::oval_probe_session_getmodel" ref="ga2ed62b62d886e985c9228d76fbee6150" args="(oval_probe_session_t *sess)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structoval__syschar__model.html">oval_syschar_model</a> * oval_probe_session_getmodel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> * </td>
<td class="paramname"><em>sess</em></td><td>)</td>
<td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get system characteristics model from probe session. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sess</td><td>pointer to the probe session structure </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga89df3c24436ed2a50770b4e00f81e525"></a><!-- doxytag: member="oval_probe_session.c::oval_probe_session_new" ref="ga89df3c24436ed2a50770b4e00f81e525" args="(struct oval_syschar_model *model)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> * oval_probe_session_new </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__syschar__model.html">oval_syschar_model</a> * </td>
<td class="paramname"><em>model</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create and initialize a new probe session. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">model</td><td>system characteristics model </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga12311e1f51159191021c24f5663925a9"></a><!-- doxytag: member="oval_probe_session.c::oval_probe_session_reset" ref="ga12311e1f51159191021c24f5663925a9" args="(oval_probe_session_t *sess, struct oval_syschar_model *sysch)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oval_probe_session_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> * </td>
<td class="paramname"><em>sess</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structoval__syschar__model.html">oval_syschar_model</a> * </td>
<td class="paramname"><em>sysch</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reset the session. </p>
<p>All state information created during the lifetime of the session is freed and reset to its initial state. All cached results are lost. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sess</td><td>pointer to the probe session structure </td></tr>
<tr><td class="paramname">sysch</td><td>pointer to a new syschar model or NULL </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaeaad2407d22a2865ff7bca1e4dec2bc9"></a><!-- doxytag: member="oval_probe_session.c::oval_probe_session_sethandler" ref="gaeaad2407d22a2865ff7bca1e4dec2bc9" args="(oval_probe_session_t *sess, oval_subtype_t type, oval_probe_handler_t handler, void *ptr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oval_probe_session_sethandler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoval__probe__session.html">oval_probe_session_t</a> * </td>
<td class="paramname"><em>sess</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__OVAL.html#ga99498f525c1a0282ef45557fc882f97f">oval_subtype_t</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__PROBEHANDLERS.html#gaa9dc58a25b744ead912c84a69bab84b6">oval_probe_handler_t</a> </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a new handler for an object of the specified type. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sess</td><td>pointer to the probe session structure </td></tr>
<tr><td class="paramname">type</td><td>object type </td></tr>
<tr><td class="paramname">handler</td><td></td></tr>
<tr><td class="paramname">ptr</td><td>user pointer that will be passed to the handler on each invocation of the handler </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Jul 25 2011 for Open SCAP Library by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
