1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  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,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 #ifndef _THREADLISTENER_HXX
24 #define _THREADLISTENER_HXX
25 
26 #include <ifinishedthreadlistener.hxx>
27 #include <ithreadlistenerowner.hxx>
28 #include <observablethread.hxx>
29 
30 /** helper class to observe threads
31 
32     OD 2007-03-30 #i73788#
33     An instance of this class can be used to observe a thread in order to
34     be notified, if the thread has finished its work. The notification is
35     directly forward to its owner - an instance of IThreadListenerOwner
36     Note:
37     - A thread can only have one or none listener.
38     - The notification is performed via the ThreadID
39 
40     @author OD
41 */
42 class ThreadListener : public IFinishedThreadListener
43 {
44     public:
45 
46         ThreadListener( IThreadListenerOwner& rThreadListenerOwner );
47         virtual ~ThreadListener();
48 
49         void ListenToThread( const oslInterlockedCount nThreadID,
50                              ObservableThread& rThread );
51 
52         virtual void NotifyAboutFinishedThread( const oslInterlockedCount nThreadID );
53 
54     private:
55 
56         IThreadListenerOwner& mrThreadListenerOwner;
57 };
58 #endif
59