blob: da5427de24c2be0a4b04e6dd31bdceb52a623412 (
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
|
/*
* @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 <<Group Tag>> <<Group Name>>
/// \ingroup tag_NS_NPPService
/// .
////////////////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup tag_NS_NPPService
/// \brief This file contains declaration of class CRegularNotification.
///
////////////////////////////////////////////////////////////////////////////////////////////////////
#ifndef NOTIFICATION_PERSISTENT_SERVICE_SERVER_INCLUDE_NS_NPP_REGULAR_NOTIFICATION_H_
#define NOTIFICATION_PERSISTENT_SERVICE_SERVER_INCLUDE_NS_NPP_REGULAR_NOTIFICATION_H_
////////////////////////////////////////////////////////////////////////////////////////////////////
// Include Files
////////////////////////////////////////////////////////////////////////////////////////////////////
#include <string>
#include "ns_npp_notification.h"
/**
* This class inherits CNotification class and implements regular notification related operations.
*/
class CRegularNotification : public CNotification {
private:
// no members in private
public:
////////////////////////////////////////////////////////////////////////////////////////////////
/// CRegularNotification
/// Constructor of CRegularNotification class
///
/// \param [IN] f_cnotificationname
/// std::string - Notification name
///
/// \param [IN] f_uimaxmsgsize
/// UI_32 - Maximum size of notification data
///
/// \return
///
////////////////////////////////////////////////////////////////////////////////////////////////
CRegularNotification(const std::string &f_cnotificationname,
const UI_32 f_uimaxmsgsize);
////////////////////////////////////////////////////////////////////////////////////////////////
/// ~CRegularNotification
/// Destructor of CRegularNotification class
///
/// \param
///
/// \return
///
////////////////////////////////////////////////////////////////////////////////////////////////
~CRegularNotification();
////////////////////////////////////////////////////////////////////////////////////////////////
/// AddEventReciever
/// This function adds the name of the application to receiver list of particular notification.
///
/// \param [IN] f_csubscribername
/// std::string - name of application subscribing for notification
///
/// \return EFrameworkunifiedStatus
// EFrameworkunifiedStatus - success or failure status
///
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus AddEventReciever(const std::string &f_csubscribername);
////////////////////////////////////////////////////////////////////////////////////////////////
/// Publish
/// This function publishes the notification to subscribed clients.
///
/// \param [IN] f_cservicename
/// std::string - name of service publishing the notification
///
/// \param [IN] f_pmessage
/// std::string - data of notification
///
/// \param [IN] f_uimsgsize
/// std::string - length of data
///
/// \return EFrameworkunifiedStatus
// EFrameworkunifiedStatus - success or failure status
///
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus Publish(const std::string &f_cservicename,
PVOID f_pmessage,
const UI_32 f_uimsgsize);
};
#endif // NOTIFICATION_PERSISTENT_SERVICE_SERVER_INCLUDE_NS_NPP_REGULAR_NOTIFICATION_H_
|
