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
|
/*
* virfilecache.h: file caching for data
*
* Copyright (C) 2017 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see
* <http://www.gnu.org/licenses/>.
*
*/
#pragma once
#include "internal.h"
#include "virobject.h"
#include "virhash.h"
typedef struct _virFileCache virFileCache;
/**
* virFileCacheIsValidPtr:
* @data: data object to validate
* @priv: private data created together with cache
*
* Validates the cached data whether it needs to be refreshed
* or no.
*
* Returns *true* if it's valid or *false* if not valid.
*/
typedef bool
(*virFileCacheIsValidPtr)(void *data,
void *priv);
/**
* virFileCacheNewDataPtr:
* @name: name of the new data
* @priv: private data created together with cache
*
* Creates a new data based on the @name. The returned data must be
* an instance of virObject.
*
* Returns data object or NULL on error.
*/
typedef void *
(*virFileCacheNewDataPtr)(const char *name,
void *priv);
/**
* virFileCacheLoadFilePtr:
* @filename: name of a file with cached data
* @name: name of the cached data
* @priv: private data created together with cache
* @outdated: set to true if data was outdated
*
* Loads the cached data from a file @filename. If
* NULL is returned, then @oudated indicates whether
* this was due to the data being outdated, or an
* error loading the cache.
*
* Returns cached data object or NULL on outdated data or error.
*/
typedef void *
(*virFileCacheLoadFilePtr)(const char *filename,
const char *name,
void *priv,
bool *outdated);
/**
* virFileCacheSaveFilePtr:
* @data: data object to save into a file
* @filename: name of the file where to store the cached data
* @priv: private data created together with cache
*
* Stores the cached to a file @filename.
*
* Returns 0 on success, -1 on error.
*/
typedef int
(*virFileCacheSaveFilePtr)(void *data,
const char *filename,
void *priv);
/**
* virFileCachePrivFreePtr:
* @priv: private data created together with cache
*
* This is used to free the private data when the cache object
* is removed.
*/
typedef void
(*virFileCachePrivFreePtr)(void *priv);
typedef struct _virFileCacheHandlers virFileCacheHandlers;
struct _virFileCacheHandlers {
virFileCacheIsValidPtr isValid;
virFileCacheNewDataPtr newData;
virFileCacheLoadFilePtr loadFile;
virFileCacheSaveFilePtr saveFile;
virFileCachePrivFreePtr privFree;
};
virFileCache *
virFileCacheNew(const char *dir,
const char *suffix,
virFileCacheHandlers *handlers);
void *
virFileCacheLookup(virFileCache *cache,
const char *name);
void *
virFileCacheLookupByFunc(virFileCache *cache,
virHashSearcher iter,
const void *iterData);
void *
virFileCacheGetPriv(virFileCache *cache);
void
virFileCacheSetPriv(virFileCache *cache,
void *priv);
int
virFileCacheInsertData(virFileCache *cache,
const char *name,
void *data);
/* for testing usage */
void
virFileCacheClear(virFileCache *cache);
|
