base/nvticache.h File Reference

Protos and data structures for NVT Information Cache. More...

#include <glib.h>
#include "nvti.h"

Go to the source code of this file.

Data Structures
struct	nvticache
	The structure for a NVTI Cache. More...
Typedefs
typedef struct nvticache	nvticache_t
	The structure for a NVTI Cache.
Functions
nvticache_t *	nvticache_new (const gchar *, const gchar *)
	Create a new nvticache structure initialized with a path.
void	nvticache_free (const nvticache_t *)
	Free memory of a nvticache structure.
nvti_t *	nvticache_get (const nvticache_t *, const gchar *)
	Retrieve NVT Information from a cache for the given filename.

---

Detailed Description

Protos and data structures for NVT Information Cache.

This file contains the protos for nvticache.c

---

Typedef Documentation

typedef struct nvticache nvticache_t

The structure for a NVTI Cache.

The elements of this structure should never be accessed directly. Only the functions corresponding to this module should be used.

---

Function Documentation

void nvticache_free

(

const nvticache_t *

cache

)

Free memory of a nvticache structure.

Parameters:

cache

The structure to be freed.

nvti_t* nvticache_get	(	const nvticache_t *	cache,
		const gchar *	filename
	)

Retrieve NVT Information from a cache for the given filename.

Parameters:

cache	The NVTI Cache to use
filename	The name of the original NVT without the path to the base location of NVTs (e.g. "scriptname1.nasl" or even "subdir1/subdir2/scriptname2.nasl" )

Returns:

NULL in case the data could not be delivered. Else a nvti structure which needs to be released using nvti_free .

nvticache_t* nvticache_new	(	const gchar *	cache_path,
		const gchar *	src_path
	)

Create a new nvticache structure initialized with a path.

Parameters:

path	The directory where the cache is to be stored.

Returns:

NULL in case the memory could not be allocated. Else a nvticache structure which needs to be released using nvticache_free .