File: structoval__agent__cb__data.tex

package info (click to toggle)
openscap 0.5.12-3
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 27,052 kB
  • ctags: 21,075
  • sloc: xml: 82,351; ansic: 52,101; sh: 17,802; makefile: 748; perl: 442; cpp: 117; python: 110
file content (69 lines) | stat: -rw-r--r-- 5,993 bytes parent folder | download
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
\hypertarget{structoval__agent__cb__data}{
\section{oval\_\-agent\_\-cb\_\-data Struct Reference}
\label{structoval__agent__cb__data}\index{oval\_\-agent\_\-cb\_\-data@{oval\_\-agent\_\-cb\_\-data}}
}


Handle all callback data that are needed by xccdf\_\-policy\_\-eval\_\-rule\_\-cb\_\-t.  


{\ttfamily \#include $<$oval\_\-agent\_\-api.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structoval__agent__cb__data}{oval\_\-agent\_\-cb\_\-data} $\ast$ \hyperlink{group__OVALAGENT_gaaeeaddad8cd993de2022553ed94b9ae0}{oval\_\-agent\_\-cb\_\-data\_\-new} (void)
\begin{DoxyCompactList}\small\item\em Create new OVAL Agent callback data. \item\end{DoxyCompactList}\item 
void \hyperlink{group__OVALAGENT_ga038c2e9ec791d86a6db76301de4628ac}{oval\_\-agent\_\-cb\_\-data\_\-free} (struct \hyperlink{structoval__agent__cb__data}{oval\_\-agent\_\-cb\_\-data} $\ast$data)
\begin{DoxyCompactList}\small\item\em Free function of OVAL Agent callback data. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{Indent}{\bf Getters}\par
{\em \label{_amgrpc9fd0bcb5385a65354c37f1bb504399d}
Return value is pointer to structure's member.

Do not free unless you null the pointer in the structure. Use remove function otherwise. }\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structoval__agent__session}{oval\_\-agent\_\-session} $\ast$ \hyperlink{group__OVALAGENT_ga8798934771d02532822073e5e6d09e66}{oval\_\-agent\_\-cb\_\-data\_\-get\_\-session} (const struct \hyperlink{structoval__agent__cb__data}{oval\_\-agent\_\-cb\_\-data} $\ast$data)
\begin{DoxyCompactList}\small\item\em Get session of OVAL Agent callback data. \item\end{DoxyCompactList}\item 
\hyperlink{group__OVALAGENT_gaf161e671e9cd718f3231044b24b15e86}{oval\_\-agent\_\-result\_\-cb\_\-t} $\ast$ \hyperlink{group__OVALAGENT_ga1589810dcfaa46fd942c38deac774491}{oval\_\-agent\_\-cb\_\-data\_\-get\_\-callback} (const struct \hyperlink{structoval__agent__cb__data}{oval\_\-agent\_\-cb\_\-data} $\ast$data)
\begin{DoxyCompactList}\small\item\em Get callback of OVAL Agent callback data. \item\end{DoxyCompactList}\item 
void $\ast$ \hyperlink{group__OVALAGENT_ga6e328a4a69868d36c89a3f031583f060}{oval\_\-agent\_\-cb\_\-data\_\-get\_\-usr} (const struct \hyperlink{structoval__agent__cb__data}{oval\_\-agent\_\-cb\_\-data} $\ast$data)
\begin{DoxyCompactList}\small\item\em Get usr data of OVAL Agent callback data. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Setters}\par
{\em \label{_amgrp6e47466b75bb957a603aa54c079ac8bf}
For lists use add functions.

Parameters of set functions are duplicated in memory and need to be freed by caller. }\begin{DoxyCompactItemize}
\item 
bool \hyperlink{group__OVALAGENT_ga9b77bd4bf6988b3e2061677f3b0a12b8}{oval\_\-agent\_\-cb\_\-data\_\-set\_\-session} (struct \hyperlink{structoval__agent__cb__data}{oval\_\-agent\_\-cb\_\-data} $\ast$data, struct \hyperlink{structoval__agent__session}{oval\_\-agent\_\-session} $\ast$\hyperlink{structoval__agent__cb__data_a354056b9e36287cced09c26d3b5f023b}{session})
\begin{DoxyCompactList}\small\item\em Set the OVAL Agent session to OVAL Agent callback data. \item\end{DoxyCompactList}\item 
bool \hyperlink{group__OVALAGENT_ga7bd156f921b42c01e68323683729dbb4}{oval\_\-agent\_\-cb\_\-data\_\-set\_\-callback} (struct \hyperlink{structoval__agent__cb__data}{oval\_\-agent\_\-cb\_\-data} $\ast$data, \hyperlink{group__OVALAGENT_gaf161e671e9cd718f3231044b24b15e86}{oval\_\-agent\_\-result\_\-cb\_\-t} $\ast$\hyperlink{structcallback__t}{callback}, void $\ast$\hyperlink{structoval__agent__cb__data_a5f397bf6e2d379327b2c59720724f78b}{usr})
\begin{DoxyCompactList}\small\item\em Set the OVAL Agent Result callback to OVAL Agent callback data. \item\end{DoxyCompactList}\item 
bool \hyperlink{group__OVALAGENT_gab4cf4016cf92228faea70c65a3a7b873}{oval\_\-agent\_\-cb\_\-data\_\-set\_\-usr} (struct \hyperlink{structoval__agent__cb__data}{oval\_\-agent\_\-cb\_\-data} $\ast$data, void $\ast$\hyperlink{structoval__agent__cb__data_a5f397bf6e2d379327b2c59720724f78b}{usr})
\begin{DoxyCompactList}\small\item\em Set the User data to OVAL Agent callback data. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item 
\hypertarget{structoval__agent__cb__data_a354056b9e36287cced09c26d3b5f023b}{
struct \hyperlink{structoval__agent__session}{oval\_\-agent\_\-session} $\ast$ \hyperlink{structoval__agent__cb__data_a354056b9e36287cced09c26d3b5f023b}{session}}
\label{structoval__agent__cb__data_a354056b9e36287cced09c26d3b5f023b}

\begin{DoxyCompactList}\small\item\em OVAL Agent session. \item\end{DoxyCompactList}\item 
\hypertarget{structoval__agent__cb__data_a9dfdb44e42a8c0f73cb2a892375a3957}{
\hyperlink{group__OVALAGENT_gaf161e671e9cd718f3231044b24b15e86}{oval\_\-agent\_\-result\_\-cb\_\-t} $\ast$ \hyperlink{structoval__agent__cb__data_a9dfdb44e42a8c0f73cb2a892375a3957}{callback}}
\label{structoval__agent__cb__data_a9dfdb44e42a8c0f73cb2a892375a3957}

\begin{DoxyCompactList}\small\item\em User callback that is called after evaluation. \item\end{DoxyCompactList}\item 
\hypertarget{structoval__agent__cb__data_a5f397bf6e2d379327b2c59720724f78b}{
void $\ast$ \hyperlink{structoval__agent__cb__data_a5f397bf6e2d379327b2c59720724f78b}{usr}}
\label{structoval__agent__cb__data_a5f397bf6e2d379327b2c59720724f78b}

\begin{DoxyCompactList}\small\item\em User data passed to callback. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Handle all callback data that are needed by xccdf\_\-policy\_\-eval\_\-rule\_\-cb\_\-t. 

The documentation for this struct was generated from the following files:\begin{DoxyCompactItemize}
\item 
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/OVAL/\hyperlink{oval__agent_8c}{oval\_\-agent.c}\item 
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/OVAL/public/\hyperlink{oval__agent__api_8h}{oval\_\-agent\_\-api.h}\end{DoxyCompactItemize}