1 /* Copyright (c) 2015, 2017 The Linux Foundation. All rights reserved.
2  *
3  * Redistribution and use in source and binary forms, with or without
4  * modification, are permitted provided that the following conditions are
5  * met:
6  *     * Redistributions of source code must retain the above copyright
7  *       notice, this list of conditions and the following disclaimer.
8  *     * Redistributions in binary form must reproduce the above
9  *       copyright notice, this list of conditions and the following
10  *       disclaimer in the documentation and/or other materials provided
11  *       with the distribution.
12  *     * Neither the name of The Linux Foundation, nor the names of its
13  *       contributors may be used to endorse or promote products derived
14  *       from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
26  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  */
29 
30 #ifndef __IDATAITEMINDEX_H__
31 #define __IDATAITEMINDEX_H__
32 
33 #include <list>
34 
35 namespace loc_core
36 {
37 
38 template <typename CT, typename DIT>
39 
40 class IDataItemIndex {
41 
42 public:
43 
44     // gets std :: list of subscribed clients
45     virtual void getListOfSubscribedClients
46     (
47         DIT id,
48         std :: list <CT> & out
49     ) = 0;
50 
51     // removes an entry from
52     virtual int remove (DIT id) = 0;
53 
54     // removes list of clients and returns a list of data items
55     // removed if any.
56     virtual void remove
57     (
58         const std :: list <CT> & r,
59         std :: list <DIT> & out
60     ) = 0;
61 
62     // removes list of clients indexed by data item and returns list of
63     // clients removed if any.
64     virtual void remove
65     (
66         DIT id,
67         const std :: list <CT> & r,
68         std :: list <CT> & out
69     ) = 0;
70 
71     // adds/modifies entry and returns new clients added
72     virtual void add
73     (
74         DIT id,
75         const std :: list <CT> & l,
76         std :: list <CT> & out
77     ) = 0;
78 
79     // adds/modifies entry and returns yet to subscribe list of data items
80     virtual void add
81     (
82         CT client,
83         const std :: list <DIT> & l,
84         std :: list <DIT> & out
85     ) = 0;
86 
87     // dtor
~IDataItemIndex()88     virtual ~IDataItemIndex () {}
89 };
90 
91 } // namespace loc_core
92 
93 #endif // #ifndef __IDATAITEMINDEX_H__
94 
95