summaryrefslogtreecommitdiffstats
path: root/nsframework/notification_persistent_service/server/src/ns_npp_handlelist.cpp
blob: c9e88a8c5f6da275eec956737bef3f4acbca3e8f (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
146
147
148
149
/*
 * @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.
//////////////////////////////////////////////////////////////////////////////////////////////////
#include <utility>
#include <string>
#include "ns_npp_handlelist.h"
#include "ns_npp_notificationpersistentservicelog.h"

// define static member of class CHandleList
CHandleList *CHandleList::m_psHandleList = NULL;

////////////////////////////////////////////////////////////////////////////////////////////////////
/// CHandleList
/// Class Constructor
////////////////////////////////////////////////////////////////////////////////////////////////////
CHandleList::CHandleList() {
  FRAMEWORKUNIFIEDLOG(ZONE_FUNC, __FUNCTION__, "+");

  FRAMEWORKUNIFIEDLOG(ZONE_FUNC, __FUNCTION__, "-");
}

////////////////////////////////////////////////////////////////////////////////////////////////////
/// CHandleList
/// Class Destructor
////////////////////////////////////////////////////////////////////////////////////////////////////
CHandleList::~CHandleList() {   // LCOV_EXCL_START 14: Resident process, global instance not released
  AGL_ASSERT_NOT_TESTED();  // LCOV_EXCL_LINE 200: test assert
  FRAMEWORKUNIFIEDLOG(ZONE_FUNC, __FUNCTION__, "+");

  FRAMEWORKUNIFIEDLOG(ZONE_FUNC, __FUNCTION__, "-");
}
// LCOV_EXCL_STOP

////////////////////////////////////////////////////////////////////////////////////////////////////
/// GetHandleList
/// This function is used to get the singleton instance of class.
////////////////////////////////////////////////////////////////////////////////////////////////////
CHandleList *CHandleList::GetHandleList() {
  FRAMEWORKUNIFIEDLOG(ZONE_FUNC, __FUNCTION__, "+");

  // create the instance of class
  if (NULL == m_psHandleList) {
    FRAMEWORKUNIFIEDLOG(ZONE_INFO, __FUNCTION__, "Creating handle list.");  // LCOV_EXCL_BR_LINE 15:marco defined in "native_service/ns_logger_if.h"
    m_psHandleList = new(std::nothrow) CHandleList();  // LCOV_EXCL_BR_LINE 11: unexpected branch
  }

  FRAMEWORKUNIFIEDLOG(ZONE_FUNC, __FUNCTION__, "-");
  return m_psHandleList;
}

////////////////////////////////////////////////////////////////////////////////////////////////////
/// ReleaseHandleList
/// This function is used to release the instance of class.
////////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus CHandleList::ReleaseHandleList() {   // LCOV_EXCL_START 100: not used
  AGL_ASSERT_NOT_TESTED();  // LCOV_EXCL_LINE 200: test assert
  EFrameworkunifiedStatus l_estatus = eFrameworkunifiedStatusOK;
  FRAMEWORKUNIFIEDLOG(ZONE_FUNC, __FUNCTION__, "+");

  if (NULL != m_psHandleList) {
    delete m_psHandleList;
    m_psHandleList = NULL;
  } else {
    l_estatus = eFrameworkunifiedStatusNullPointer;
  }

  FRAMEWORKUNIFIEDLOG(ZONE_FUNC, __FUNCTION__, "-");
  return l_estatus;
}
// LCOV_EXCL_STOP

////////////////////////////////////////////////////////////////////////////////////////////////
/// AddHandleInList
/// Add pair of subscriber name and corresponding handle in map.
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus CHandleList::AddHandleInList(std::string f_csubscribername, HANDLE f_hmqhandle) {
  EFrameworkunifiedStatus l_estatus = eFrameworkunifiedStatusOK;
  HandleListRetStatus_Type l_prRetValue;
  FRAMEWORKUNIFIEDLOG(ZONE_FUNC, __FUNCTION__, "+");

  l_prRetValue = m_mHandleList.insert(make_pair(f_csubscribername, f_hmqhandle));
  if (false == l_prRetValue.second) {
    l_estatus = eFrameworkunifiedStatusDuplicate;
    FRAMEWORKUNIFIEDLOG(ZONE_NPP_INFO, __FUNCTION__, "Handle exists in list for %s.", f_csubscribername.c_str());
  } else {
    FRAMEWORKUNIFIEDLOG(ZONE_NPP_INFO, __FUNCTION__, "Handle added in list for %s.", f_csubscribername.c_str());  // LCOV_EXCL_BR_LINE 15:marco defined in "native_service/ns_logger_if.h"
  }


  FRAMEWORKUNIFIEDLOG(ZONE_FUNC, __FUNCTION__, "-");
  return l_estatus;
}


////////////////////////////////////////////////////////////////////////////////////////////////
/// RemoveHandleFromList
/// Remove handle for subscriber from the list.
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus CHandleList::RemoveHandleFromList(std::string f_csubscribername) {   // LCOV_EXCL_START 100: not used
  AGL_ASSERT_NOT_TESTED();  // LCOV_EXCL_LINE 200: test assert
  // TODO(my_username): Implementation of this function.
  // NOTE: Right now this feature is not required. Let the NS_NPPService hold one handle for
  //    each subscriber, even if all the notifications are unsubscribed by subscriber.
  return eFrameworkunifiedStatusOK;
}
// LCOV_EXCL_STOP

////////////////////////////////////////////////////////////////////////////////////////////////
/// GetSubscriberMqHandle
/// Get the message queue handle of a subscriber.
////////////////////////////////////////////////////////////////////////////////////////////////
HANDLE CHandleList::GetSubscriberMqHandle(std::string f_csubscribername) {
  HANDLE l_hMqHandle = NULL;
  HandleList_Type::iterator l_itHandleList;
  FRAMEWORKUNIFIEDLOG(ZONE_FUNC, __FUNCTION__, "+");

  l_itHandleList = m_mHandleList.find(f_csubscribername);
  if (l_itHandleList != m_mHandleList.end()) {
    l_hMqHandle = l_itHandleList->second;
  }
  FRAMEWORKUNIFIEDLOG(ZONE_FUNC, __FUNCTION__, "-");
  return l_hMqHandle;
}