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
|
/*
* @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
//////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup tag_NPServiceIf
/// \brief This file contains the declaration for internal functions to retrieve and store
/// immediate notification data from and to persistent storage.
///
///
///
//////////////////////////////////////////////////////////////////////////////////////////////////
#ifndef FRAMEWORK_UNIFIED_CLIENT_NS_NPSERVICEIF_INCLUDE_NS_NP_SERVICE_NOR_PERSISTENCE_INTERNAL_H_
#define FRAMEWORK_UNIFIED_CLIENT_NS_NPSERVICEIF_INCLUDE_NS_NP_SERVICE_NOR_PERSISTENCE_INTERNAL_H_
///////////////////////////////////////////////////////////////////////////////
// Include Files
///////////////////////////////////////////////////////////////////////////////
#include <native_service/frameworkunified_types.h>
#include <native_service/ns_np_service.h>
#ifdef __cplusplus
extern "C" {
#endif
////////////////////////////////////////////////////////////////////////////////////////////
/// NPSynchronousGetPersistentData
/// API to retrieve immediate storage notification data structure.
///
///
/// \param [in] pAppName
/// PCSTR - Name of application service
/// \param [in] notif_name
/// PCSTR - Name of notification to be written to immediate storage
/// \param [in] pData
/// PVOID - Notification data
/// \param [in] uiDataSize
/// UI_32 - Size of notification data
/// \param [out] ptNorPersistentData
/// NC_NorPersistentData - Immediate notification structure
/// \param [in] ePersistCategory
/// const EFrameworkunifiedPersistCategory - Persist Category of Notification.
///
/// \return status
/// EFrameworkunifiedStatus - success or error
////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus NPSynchronousGetPersistentData(PCSTR pAppName,
PCSTR notif_name,
PVOID pData,
UI_32 uiDataSize,
NC_NorPersistentData &ptNorPersistentData,
const EFrameworkunifiedPersistCategory ePersistCategory);
////////////////////////////////////////////////////////////////////////////////////////////
/// NPSynchronousGetPersistentDataSize
/// API to get immediate storage notification data size.
///
/// \param [in] notif_name
/// PCSTR - Name of notification to be read from immediate storage
/// \param [out] uiDataSize
/// PUI_32 - notification data size
/// \param [in] ePersistCategory
/// const EFrameworkunifiedPersistCategory - Persist Category of Notification.
///
/// \return EFrameworkunifiedStatus
/// EFrameworkunifiedStatus - success or failure
////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus NPSynchronousGetPersistentDataSize(PCSTR notif_name,
PUI_32 uiDataSize,
const EFrameworkunifiedPersistCategory ePersistCategory);
////////////////////////////////////////////////////////////////////////////////////////////
/// SynchronousGetPersistentDataSize
/// API to write immediate persistence notification data.
///
/// \param [in] notif_name
/// PCSTR - Name of notification to be read from immediate storage
/// \param [in] ePersistCategory
/// const EFrameworkunifiedPersistCategory - Persist Category of Notification.
///
/// \return UI_32
/// UI_32 - size of the data
////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus SynchronousWritePersistentData(PCSTR pAppName,
PCSTR notif_name,
PVOID pData,
const UI_32 uiDataSize,
const UI_32 uiDelay,
const UI_32 uiMaxSize,
const EFrameworkunifiedPersistCategory ePersistCategory);
////////////////////////////////////////////////////////////////////////////////////////////
/// SynchronousMovePersistentData
/// API to move all the immediate notification data from f_cSrcDir directory to
/// f_cDestDir directory
///
/// \param [in] f_cSrcDir
/// PCSTR - Source directory full path
/// \param [in] f_cDestDir
/// PCSTR - Dest directory full path
///
/// \return EFrameworkunifiedStatus
/// EFrameworkunifiedStatus - eFrameworkunifiedStatusAccessError if source path not exists
/// eFrameworkunifiedStatusFileLoadError if unable to access src directory
/// eFrameworkunifiedStatusInvldParam if invalid parameter is received
/// eFrameworkunifiedStatusFail if error occurs while copying file
/// eFrameworkunifiedStatus on success
////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus SynchronousMovePersistentData(PCSTR f_cSrcDir,
PCSTR f_cDestDir);
#ifdef __cplusplus
}
#endif
#endif // FRAMEWORK_UNIFIED_CLIENT_NS_NPSERVICEIF_INCLUDE_NS_NP_SERVICE_NOR_PERSISTENCE_INTERNAL_H_
// EOF
|
