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 __ICLIENTINDEX_H__
31 #define __ICLIENTINDEX_H__
32 
33 #include <list>
34 
35 namespace loc_core
36 {
37 
38 template  <typename CT, typename DIT>
39 
40 class IClientIndex {
41 public:
42 
43     // Checks if client is subscribed
44     virtual bool isSubscribedClient (CT client) = 0;
45 
46     // gets subscription list
47     virtual void getSubscribedList (CT client, std :: list <DIT> & out) = 0;
48 
49     // removes an entry
50     virtual int remove (CT client) = 0;
51 
52     // removes std :: list of data items and returns a list of clients
53     // removed if any.
54     virtual void remove
55     (
56         const std :: list <DIT> & r,
57         std :: list <CT> & out
58     ) = 0;
59 
60     // removes list of data items indexed by client and returns list
61     // of data items removed if any.
62     virtual void remove
63     (
64         CT client,
65         const std :: list <DIT> & r,
66         std :: list <DIT> & out
67     ) = 0;
68 
69     // adds/modifies entry in  map and returns new data items added.
70     virtual void add
71     (
72         CT client,
73         const std :: list <DIT> & l,
74         std :: list <DIT> & out
75     ) = 0;
76 
77     // dtor
~IClientIndex()78     virtual ~IClientIndex () {}
79 };
80 
81 } // namespace loc_core
82 
83 #endif // #ifndef __ICLIENTINDEX_H__
84