1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
<!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.3.1"/>
<title>Open SCAP Library: Probe session API</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.3.1 -->
<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><!-- top -->
<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> </div>
<div class="headertitle">
<div class="title">Probe session API<div class="ingroups"><a class="el" href="group__PROBES.html">System checking mechanism - probes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><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 class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">OVAL probe session structure. <a href="structoval__probe__session.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga295f5308d30c7e491f9fa9ba3f408431"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga295f5308d30c7e491f9fa9ba3f408431"></a>
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 class="separator:ga295f5308d30c7e491f9fa9ba3f408431"><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:ga89df3c24436ed2a50770b4e00f81e525"><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 class="memdesc:ga89df3c24436ed2a50770b4e00f81e525"><td class="mdescLeft"> </td><td class="mdescRight">Create and initialize a new probe session. <a href="#ga89df3c24436ed2a50770b4e00f81e525">More...</a><br/></td></tr>
<tr class="separator:ga89df3c24436ed2a50770b4e00f81e525"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga570a8ec1ddefa3dea49b75b7ba430d82"><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 class="memdesc:ga570a8ec1ddefa3dea49b75b7ba430d82"><td class="mdescLeft"> </td><td class="mdescRight">Destroy probe session. <a href="#ga570a8ec1ddefa3dea49b75b7ba430d82">More...</a><br/></td></tr>
<tr class="separator:ga570a8ec1ddefa3dea49b75b7ba430d82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7875c98b154cb7b574d500920a5da432"><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 class="memdesc:ga7875c98b154cb7b574d500920a5da432"><td class="mdescLeft"> </td><td class="mdescRight">Send a close request to all probes. <a href="#ga7875c98b154cb7b574d500920a5da432">More...</a><br/></td></tr>
<tr class="separator:ga7875c98b154cb7b574d500920a5da432"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga12311e1f51159191021c24f5663925a9"><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 class="memdesc:ga12311e1f51159191021c24f5663925a9"><td class="mdescLeft"> </td><td class="mdescRight">Reset the session. <a href="#ga12311e1f51159191021c24f5663925a9">More...</a><br/></td></tr>
<tr class="separator:ga12311e1f51159191021c24f5663925a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga15b2a32e07b0affdb2d263f2a6f83fbf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga15b2a32e07b0affdb2d263f2a6f83fbf"></a>
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 class="memdesc:ga15b2a32e07b0affdb2d263f2a6f83fbf"><td class="mdescLeft"> </td><td class="mdescRight">Abort the session. <br/></td></tr>
<tr class="separator:ga15b2a32e07b0affdb2d263f2a6f83fbf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeaad2407d22a2865ff7bca1e4dec2bc9"><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 class="memdesc:gaeaad2407d22a2865ff7bca1e4dec2bc9"><td class="mdescLeft"> </td><td class="mdescRight">Set a new handler for an object of the specified type. <a href="#gaeaad2407d22a2865ff7bca1e4dec2bc9">More...</a><br/></td></tr>
<tr class="separator:gaeaad2407d22a2865ff7bca1e4dec2bc9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2ed62b62d886e985c9228d76fbee6150"><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 class="memdesc:ga2ed62b62d886e985c9228d76fbee6150"><td class="mdescLeft"> </td><td class="mdescRight">Get system characteristics model from probe session. <a href="#ga2ed62b62d886e985c9228d76fbee6150">More...</a><br/></td></tr>
<tr class="separator:ga2ed62b62d886e985c9228d76fbee6150"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga7875c98b154cb7b574d500920a5da432"></a>
<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 class="params"><dt>Parameters</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>
<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 class="params"><dt>Parameters</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>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get system characteristics model from probe session. </p>
<dl class="params"><dt>Parameters</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>
<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 class="params"><dt>Parameters</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>
<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 class="params"><dt>Parameters</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>
<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 class="params"><dt>Parameters</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><!-- 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.3.1
</small></address>
</body>
</html>
|
