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
|
/* $Id: */
/** @file
* VBoxServicePropCache - Guest property cache.
*/
/*
* Copyright (C) 2010-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program 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
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef GA_INCLUDED_SRC_common_VBoxService_VBoxServicePropCache_h
#define GA_INCLUDED_SRC_common_VBoxService_VBoxServicePropCache_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include "VBoxServiceInternal.h"
#ifdef VBOX_WITH_GUEST_PROPS
/** @name VGSVCPROPCACHE_FLAG_XXX - Guest Property Cache Flags.
* @{ */
/** Indicates wheter a guest property is temporary and either should
* - a) get a "reset" value assigned (via VBoxServicePropCacheUpdateEntry)
* as soon as the property cache gets destroyed, or
* - b) get deleted when no reset value is specified.
*/
# define VGSVCPROPCACHE_FLAGS_TEMPORARY RT_BIT(1)
/** Indicates whether a property every time needs to be updated, regardless
* if its real value changed or not. */
# define VGSVCPROPCACHE_FLAGS_ALWAYS_UPDATE RT_BIT(2)
/** The guest property gets deleted when
* - a) the property cache gets destroyed, or
* - b) the VM gets reset / shutdown / destroyed.
*/
# define VGSVCPROPCACHE_FLAGS_TRANSIENT RT_BIT(3)
/** @} */
int VGSvcPropCacheCreate(PVBOXSERVICEVEPROPCACHE pCache, uint32_t uClientId);
int VGSvcPropCacheUpdateEntry(PVBOXSERVICEVEPROPCACHE pCache, const char *pszName, uint32_t fFlags, const char *pszValueReset);
int VGSvcPropCacheUpdate(PVBOXSERVICEVEPROPCACHE pCache, const char *pszName, const char *pszValueFormat, ...);
int VGSvcPropCacheUpdateByPath(PVBOXSERVICEVEPROPCACHE pCache, const char *pszValue, uint32_t fFlags,
const char *pszPathFormat, ...);
int VGSvcPropCacheFlush(PVBOXSERVICEVEPROPCACHE pCache);
void VGSvcPropCacheDestroy(PVBOXSERVICEVEPROPCACHE pCache);
#endif /* VBOX_WITH_GUEST_PROPS */
#endif /* !GA_INCLUDED_SRC_common_VBoxService_VBoxServicePropCache_h */
|
