Open SCAP Library
Data Structures | Typedefs | Functions | Variables
Probe session API
System checking mechanism - probes

Data Structures

struct  oval_probe_session
 OVAL probe session structure. More...

Typedefs

typedef struct oval_probe_session oval_probe_session_t

Functions

oval_probe_session_toval_probe_session_new (struct oval_syschar_model *model)
 Create and initialize a new probe session.
void oval_probe_session_destroy (oval_probe_session_t *sess)
 Destroy probe session.
int oval_probe_session_close (oval_probe_session_t *sess)
 Send a close request to all probes.
int oval_probe_session_reset (oval_probe_session_t *sess, struct oval_syschar_model *sysch)
 Reset the session.
int oval_probe_session_abort (oval_probe_session_t *sess)
 Abort the session.
int oval_probe_session_sethandler (oval_probe_session_t *sess, oval_subtype_t type, oval_probe_handler_t handler, void *ptr)
 Set a new handler for an object of the specified type.
struct oval_syschar_modeloval_probe_session_getmodel (oval_probe_session_t *sess)
 Get system characteristics model from probe session.

Variables

void * oval_probe_session::pext
 dummy pointer
struct oval_syschar_modeloval_probe_session::sys_model
 system characteristics model
char * oval_probe_session::dir
 probe session directory
uint32_t oval_probe_session::flg
 probe session flags

Function Documentation

int oval_probe_session_close ( oval_probe_session_t sess)

Send a close request to all probes.

In case of external probes, the running processes are shutdown - all cached results are lost.

Parameters:
sesspointer to the probe session structure
void oval_probe_session_destroy ( oval_probe_session_t sess)

Destroy probe session.

All state information created during the lifetime of the session is freed, resources used by probes are freed using the probe handler API.

Parameters:
sesspointer to the probe session structure
struct oval_syschar_model * oval_probe_session_getmodel ( oval_probe_session_t sess) [read]

Get system characteristics model from probe session.

Parameters:
sesspointer to the probe session structure
oval_probe_session_t * oval_probe_session_new ( struct oval_syschar_model model)

Create and initialize a new probe session.

Parameters:
modelsystem characteristics model
int oval_probe_session_reset ( oval_probe_session_t sess,
struct oval_syschar_model sysch 
)

Reset the session.

All state information created during the lifetime of the session is freed and reset to its initial state. All cached results are lost.

Parameters:
sesspointer to the probe session structure
syschpointer to a new syschar model or NULL
int oval_probe_session_sethandler ( oval_probe_session_t sess,
oval_subtype_t  type,
oval_probe_handler_t  handler,
void *  ptr 
)

Set a new handler for an object of the specified type.

Parameters:
sesspointer to the probe session structure
typeobject type
handler
ptruser pointer that will be passed to the handler on each invocation of the handler