blob: 30c8a26fcb6b7267cbc94442a4d2416e04865079 (
plain)
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
142
143
144
145
|
/*
* @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.
*/
//////////////////////////////////////////////////////////////////////////////////////////////////
/// \defgroup tag_NS_NPPService
/// \ingroup tag_NS_NPPService
///
//////////////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup tag_NS_NPPService
/// \brief This class holds the message queue handles for notification subscribers
///
/// This is a singleton class which holds the message queue handles for notification subscribers.
/// This will ensure that NS_NPPService will hold only one handle per subscriber.
//////////////////////////////////////////////////////////////////////////////////////////////////
#ifndef NOTIFICATION_PERSISTENT_SERVICE_SERVER_INCLUDE_NS_NPP_HANDLELIST_H_
#define NOTIFICATION_PERSISTENT_SERVICE_SERVER_INCLUDE_NS_NPP_HANDLELIST_H_
#include <native_service/frameworkunified_types.h>
#include <string>
#include <map>
#include <utility>
typedef std::map<std::string, HANDLE> HandleList_Type;
typedef std::pair<HandleList_Type::iterator, bool> HandleListRetStatus_Type;
/**
* This class holds the message queue handles for notification subscribers
*/
class CHandleList {
public:
////////////////////////////////////////////////////////////////////////////////////////////////
/// GetHandleList
/// This function is used to get the singleton instance of class.
/// NOTE: Not thread safe. Others threads would not use this function.
///
/// \return CHandleList
/// CHandleList - singleton instance of class
///
////////////////////////////////////////////////////////////////////////////////////////////////
static CHandleList *GetHandleList();
////////////////////////////////////////////////////////////////////////////////////////////////
/// ReleaseHandleList
/// This function is used to release the instance of class.
/// NOTE: Not thread safe. Others threads would not use this function.
///
/// \param
///
/// \return EFrameworkunifiedStatus
// EFrameworkunifiedStatus - success or failure status
///
////////////////////////////////////////////////////////////////////////////////////////////////
static EFrameworkunifiedStatus ReleaseHandleList();
////////////////////////////////////////////////////////////////////////////////////////////////
/// AddHandleInList
/// Add pair of subscriber name and corresponding handle in map.
/// NOTE: Not thread safe. Others threads would not use this function.
///
/// \param [IN] f_csubscribername
/// std::string - name of application subscribing for notification
/// \param [IN] f_hmqhandle
/// HANDLE - Message queue handle of the subscriber
///
/// \return EFrameworkunifiedStatus
// EFrameworkunifiedStatus -
///
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus AddHandleInList(std::string f_csubscribername, HANDLE f_hmqhandle);
////////////////////////////////////////////////////////////////////////////////////////////////
/// RemoveHandleFromList
/// Remove handle for subscriber from the list.
/// Handle will actually get removed when all the notifications are unsubscribed by the subscriber
/// NOTE: Not thread safe. Others threads would not use this function.
///
/// \param [IN] f_csubscribername
/// std::string - name of application subscribing for notification
///
/// \return EFrameworkunifiedStatus
// EFrameworkunifiedStatus -
///
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus RemoveHandleFromList(std::string f_csubscribername);
////////////////////////////////////////////////////////////////////////////////////////////////
/// GetSubscriberMqHandle
/// Get the message queue handle of a subscriber.
/// NOTE: Not thread safe. Others threads would not use this function.
///
/// \param [IN] f_csubscribername
/// std::string - name of application subscribing for notification
///
/// \return HANDLE
// HANDLE - Message queue handle of the subscriber
///
////////////////////////////////////////////////////////////////////////////////////////////////
HANDLE GetSubscriberMqHandle(std::string f_csubscribername);
private:
////////////////////////////////////////////////////////////////////////////////////////////////
/// CHandleList
/// Constructor of CHandleList class
///
/// \param
///
/// \return
///
////////////////////////////////////////////////////////////////////////////////////////////////
CHandleList();
////////////////////////////////////////////////////////////////////////////////////////////////
/// ~CHandleList
/// Destructor of CHandleList class
///
/// \param
///
/// \return
///
////////////////////////////////////////////////////////////////////////////////////////////////
~CHandleList();
HandleList_Type m_mHandleList; ///< map which stores all the message queue handle
static CHandleList *m_psHandleList; // NOLINT (readability/naming)
};
#endif // NOTIFICATION_PERSISTENT_SERVICE_SERVER_INCLUDE_NS_NPP_HANDLELIST_H_
|
