mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-10-06 06:15:46 +00:00
c8238579fb
Historically, we declared pointer type to our types: typedef struct _virXXX virXXX; typedef virXXX *virXXXPtr; But usefulness of such declaration is questionable, at best. Unfortunately, we can't drop every such declaration - we have to carry some over, because they are part of public API (e.g. virDomainPtr). But for internal types - we can do drop them and use what every other C project uses 'virXXX *'. This change was generated by a very ugly shell script that generated sed script which was then called over each file in the repository. For the shell script refer to the cover letter: https://listman.redhat.com/archives/libvir-list/2021-March/msg00537.html Signed-off-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Peter Krempa <pkrempa@redhat.com>
138 lines
3.7 KiB
C
138 lines
3.7 KiB
C
/*
|
|
* 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);
|