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
|
#ifndef PERSISTENCY_CLIENT_LIBRARY_H
#define PERSISTENCY_CLIENT_LIBRARY_H
/******************************************************************************
* Project Persistency
* (c) copyright 2011
* Company XS Embedded GmbH
*****************************************************************************/
/******************************************************************************
* This Source Code Form is subject to the terms of the
* Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed
* with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
******************************************************************************/
/**
* \file persistence_client_library.h
* \ingroup Persistence client library
* \author Ingo Huerner (XSe) / Guy Sagnes (Continental)
* \brief Header of the persistence client library.
* Library provides an API to access persistent data
* \par change history
* Date Author Version
* 25/06/13 Ingo Hürner 1.0.0 - Rework of Init functions
* 04/11/13 Ingo Hürner 2.0.0 - Added define for shutdown type none
*
*/
/** \ingroup GEN_PERS */
/** \defgroup PERS_CLIENT Client: initialisation access
* \{
*/
/** \defgroup PERS_CLIENT_INTERFACE API document
* \{
*/
#ifdef __cplusplus
extern "C" {
#endif
/** \defgroup PCL_DEFINES_API Defines, Struct, Enum
* \{
*/
#define PERSIST_API_INTERFACE_VERSION (0x01030000U)
/** \} */
/** \defgroup PCL_OVERALL functions for Library Initialisation
* The following functions have to be called to allow intialisation of the internal interfaces.
* \{
*/
#define PCL_SHUTDOWN 1 /// trigger shutdown
#define PCL_SHUTDOWN_CANEL 0 // cancel shutdown
#define PCL_SHUTDOWN_TYPE_FAST 2 /// Client registered for fast lifecycle shutdown
#define PCL_SHUTDOWN_TYPE_NORMAL 1 /// Client registered for normal lifecycle shutdown
#define PCL_SHUTDOWN_TYPE_NONE 0 /// Client does not register to lifecycle shutdown
/**
* @brief initalize client library.
* This function will be called by the process using the PCL during startup phase.
*
* @attention This function is currently N O T part of the GENIVI compliance specification
*
* @param appname application name, the name must be a unique name in the system
* @param shutdownMode shutdown mode ::PCL_SHUTDOWN_TYPE_FAST or ::PCL_SHUTDOWN_TYPE_NORMAL
*
* @return positive value: success;
* On error a negative value will be returned with the following error codes:
* ::EPERS_NOT_INITIALIZED, ::EPERS_INIT_DBUS_MAINLOOP,
* ::EPERS_REGISTER_LIFECYCLE, ::EPERS_REGISTER_ADMIN
*/
int pclInitLibrary(const char* appname, int shutdownMode);
/**
* @brief deinitialize client library
* This function will be called during the shutdown phase of the process which uses the PCL.
*
* @attention This function is currently N O T part of the GENIVI compliance specification
*
* @return positive value: success;
* On error a negative value will be returned.
*/
int pclDeinitLibrary(void);
/**
* @brief pclLifecycleSet client library
* This function can be called if to flush and write back the data form cache to memory device.
* The function is only available if PCL_SHUTDOWN_TYPE_NONE has been used in pclInitLibrary.
*
* @attention This function is currently N O T part of the GENIVI compliance specification
* @attention In order to prevent misuse of this function the cancel shutdown request
* can only be called 3 times per lifecycle.
*
* @parm PCL_SHUTDOWN for write back data when shutdown is requested,
* and PCL_SHUTDOWN_CANEL when shutdown cancel request has been received.
*
* @return positive value: success;
* On error a negative value will be returned with the following error codes:
* ::EPERS_COMMON, :.EPERS_MAX_CANCEL_SHUTDOWN, ::EPERS_SHTDWN_NO_PERMIT
*/
int pclLifecycleSet(int shutdown);
/** \} */
#ifdef __cplusplus
}
#endif
/** \} */ /* End of API */
/** \} */ /* End of MODULE */
#endif /* PERSISTENCY_CLIENT_LIBRARY_H */
|
