summaryrefslogtreecommitdiff
path: root/configmgr/source/treecache/cachemulticaster.hxx
blob: 15cbb44d98de9fe83f169f4a009095a832c24691 (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef CONFIGMGR_BACKEND_CACHEMULTICASTER_HXX
#define CONFIGMGR_BACKEND_CACHEMULTICASTER_HXX

#include "sal/config.h"

#include <list>

#include "osl/mutex.hxx"
#include "rtl/ref.hxx"

#include "utility.hxx"

namespace configmgr
{
    class TreeManager;

    namespace backend
    {
        class ComponentRequest;
        class UpdateRequest;
// ---------------------------------------------------------------------------

    /** Interface providing a multicasting service for changes to the cache 
        managed by a <type>CacheController</type>
    */
    class CacheChangeMulticaster
    {
    public:      
        CacheChangeMulticaster();
        virtual ~CacheChangeMulticaster();

        /** notify a new component to all registered listeners.
            <p> Must be called after the component has been created in the cache.</p>
        */
        void notifyCreated(ComponentRequest const & _aComponentName) SAL_THROW(());

        /** notify changed data to all registered listeners.
            <p> Must be called after the change has been applied to the cache
                and before any subsequent changes to the same component.</p>
        */
        void notifyChanged(UpdateRequest const & _anUpdate) SAL_THROW(());

    // notification support. 
        /// register a listener for observing changes to the cached data
        void addListener(rtl::Reference<TreeManager> _xListener) SAL_THROW(());
        /// unregister a listener previously registered
        void removeListener(rtl::Reference<TreeManager> _xListener) SAL_THROW(());
    private:
        std::list< rtl::Reference<TreeManager> > copyListenerList();

        osl::Mutex   m_aMutex;
        std::list< rtl::Reference<TreeManager> > m_aListeners;
    };
// ---------------------------------------------------------------------------
    } // namespace backend

// ---------------------------------------------------------------------------
} // namespace configmgr

#endif