Open SCAP Library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | Data Fields
ds_stream_index Struct Reference

Contains information about one particular "<data-stream>" element in the datastream collection (also called SDS = source datastream). More...

#include <scap_ds.h>

Public Member Functions

OSCAP_API struct ds_stream_indexds_stream_index_new (void)
 
OSCAP_API void ds_stream_index_free (struct ds_stream_index *s)
 
OSCAP_API const char * ds_stream_index_get_id (struct ds_stream_index *s)
 Gets ID of the <data-stream> element the index represents.
 
OSCAP_API const char * ds_stream_index_get_timestamp (struct ds_stream_index *s)
 Timestamp of creation OR modification of the <data-stream> element the index represents.
 
OSCAP_API const char * ds_stream_index_get_version (struct ds_stream_index *s)
 scap-version of the the <data-stream> element the index represents.
 
OSCAP_API struct
oscap_string_iterator
ds_stream_index_get_checks (struct ds_stream_index *s)
 Retrieves iterator over all components inside the <checks> element.
 
OSCAP_API struct
oscap_string_iterator
ds_stream_index_get_checklists (struct ds_stream_index *s)
 Retrieves iterator over all components inside the <checklists> element.
 
OSCAP_API struct
oscap_string_iterator
ds_stream_index_get_dictionaries (struct ds_stream_index *s)
 Retrieves iterator over all components inside the <dictionaries> element.
 
OSCAP_API struct
oscap_string_iterator
ds_stream_index_get_extended_components (struct ds_stream_index *s)
 Retrieves iterator over all components inside the <extended-components> element.
 

Data Fields

char * id
 
char * timestamp
 
char * version
 
struct oscap_stringlistcheck_components
 
struct oscap_stringlistchecklist_components
 
struct oscap_stringlistdictionary_components
 
struct oscap_stringlistextended_components
 
struct oscap_htablecomponent_id_to_component_ref_id
 

Detailed Description

Contains information about one particular "<data-stream>" element in the datastream collection (also called SDS = source datastream).

Is contained inside ds_sds_index which indexes the entire datastream collection.

Only contains IDs, does not contain the data of components themselves! See ds_sds_decompose for that.

Inside it are components divided into categories called "containers". These are "checks", "checklists", "dictionaries" and "extended-components". See the specification for more details about their meaning.

See Also
ds_sds_index

The documentation for this struct was generated from the following files: