Use `URI` all caps in documentation
[iotivity.git] / service / resource-container / bundle-api / include / NotificationReceiver.h
1 //******************************************************************
2 //
3 // Copyright 2015 Samsung Electronics All Rights Reserved.
4 //
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
6 //
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
10 //
11 //      http://www.apache.org/licenses/LICENSE-2.0
12 //
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
18 //
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
20
21 #ifndef NOTIFICATIONRECEIVER_H_
22 #define NOTIFICATIONRECEIVER_H_
23
24 #include <string>
25
26 namespace OIC
27 {
28     namespace Service
29     {
30
31         /**
32         * @class    NotificationReceiver
33         * @brief    This class represents Notification Receiver to get notification
34         *               from bundle resources if there's any changes of attribute state
35         *
36         */
37         class NotificationReceiver
38         {
39             public:
40
41                 /**
42                 * Constructor for NotificationReceiver
43                 */
44                 NotificationReceiver()
45                 {
46
47                 };
48
49                 /**
50                 * destructor for NotificationReceiver
51                 */
52                 ~NotificationReceiver()
53                 {
54
55                 };
56
57                 /**
58                 * Callback method for getting notification from bundle resources
59                 *
60                 * @param strResourceUri URI of attribute updated bundle resource
61                 *
62                 * @return void
63                 */
64                 virtual void onNotificationReceived(const std::string &strResourceUri) = 0;
65         };
66     }
67 }
68
69 #endif