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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* 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 COMPHELPER_ASYNCNOTIFICATION_HXX
#define COMPHELPER_ASYNCNOTIFICATION_HXX
#include <osl/thread.hxx>
#include <rtl/ref.hxx>
#include <comphelper/comphelperdllapi.h>
#include <rtl/alloc.h>
#include <memory>
//........................................................................
namespace comphelper
{
//........................................................................
//====================================================================
//= AnyEvent
//====================================================================
/** the very basic instance to hold a description of an event
*/
class COMPHELPER_DLLPUBLIC AnyEvent : ::rtl::IReference
{
private:
oslInterlockedCount m_refCount;
public:
AnyEvent();
virtual oslInterlockedCount SAL_CALL acquire();
virtual oslInterlockedCount SAL_CALL release();
protected:
virtual ~AnyEvent();
private:
AnyEvent( AnyEvent& ); // not defined
void operator=( AnyEvent& ); // not defined
};
//====================================================================
//= typedefs
//====================================================================
typedef ::rtl::Reference< AnyEvent > AnyEventRef;
//====================================================================
//= IEventProcessor
//====================================================================
/** an event processor
@see AsyncEventNotifier
*/
class SAL_NO_VTABLE IEventProcessor
{
public:
/** process a single event
*/
virtual void processEvent( const AnyEvent& _rEvent ) = 0;
virtual void SAL_CALL acquire() = 0;
virtual void SAL_CALL release() = 0;
};
//====================================================================
//= AsyncEventNotifier
//====================================================================
typedef ::osl::Thread AsyncEventNotifier_TBASE;
struct EventNotifierImpl;
/** a helper class for notifying events asynchronously
If you need to notify certain events to external components, you usually should
not do this while you have mutexes locked, to prevent multi-threading issues.
However, you do not always have complete control over all mutex guards on the stack.
If, in such a case, the listener notification is one-way, you can decide to do it
asynchronously.
The ->AsyncEventNotifier helps you to process such events asynchronously. Every
event is tied to an ->IEventProcessor which is responsible for processing it.
The AsyncEventNotifier is implemented as a thread itself, which sleeps as long as there are no
events in the queue. As soon as you add an event, the thread is woken up, processes the event,
and sleeps again.
*/
class COMPHELPER_DLLPUBLIC AsyncEventNotifier :protected AsyncEventNotifier_TBASE
,public ::rtl::IReference
{
friend struct EventNotifierImpl;
private:
::std::auto_ptr< EventNotifierImpl > m_pImpl;
protected:
// Thread
virtual void SAL_CALL run();
virtual void SAL_CALL onTerminated();
public:
/** constructs a notifier thread
*/
AsyncEventNotifier();
// IReference implementations
virtual oslInterlockedCount SAL_CALL acquire();
virtual oslInterlockedCount SAL_CALL release();
using AsyncEventNotifier_TBASE::create;
using AsyncEventNotifier_TBASE::join;
using AsyncEventNotifier_TBASE::getIdentifier;
using AsyncEventNotifier_TBASE::operator new;
using AsyncEventNotifier_TBASE::operator delete;
/** terminates the thread
Note that this is a cooporative termination - if you call this from a thread different
from the notification thread itself, then it will block until the notification thread
finished processing the current event. If you call it from the notification thread
itself, it will return immediately, and the thread will be terminated as soon as
the current notification is finished.
*/
virtual void SAL_CALL terminate();
/** adds an event to the queue, together with the instance which is responsible for
processing it
@param _rEvent
the event to add to the queue
@param _xProcessor
the processor for the event.<br/>
Beware of life time issues here. If your event processor dies or becomes otherwise
nonfunctional, you are responsible for removing all respective events from the queue.
You can do this by calling ->removeEventsForProcessor
*/
void addEvent( const AnyEventRef& _rEvent, const ::rtl::Reference< IEventProcessor >& _xProcessor );
/** removes all events for the given event processor from the queue
*/
void removeEventsForProcessor( const ::rtl::Reference< IEventProcessor >& _xProcessor );
protected:
virtual ~AsyncEventNotifier();
};
//====================================================================
//= EventHolder
//====================================================================
/** AnyEvent derivee holding an foreign event instance
*/
template < typename EVENT_OBJECT >
class EventHolder : public AnyEvent
{
public:
typedef EVENT_OBJECT EventObjectType;
private:
EventObjectType m_aEvent;
public:
inline EventHolder( const EventObjectType& _rEvent )
:m_aEvent( _rEvent )
{
}
inline const EventObjectType& getEventObject() const { return m_aEvent; }
};
//........................................................................
} // namespace comphelper
//........................................................................
#endif // COMPHELPER_ASYNCNOTIFICATION_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
