xref: /AOO41X/main/framework/inc/helper/wakeupthread.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef __FRAMEWORK_HELPER_WAKEUPTHREAD_HXX_
29*cdf0e10cSrcweir #define __FRAMEWORK_HELPER_WAKEUPTHREAD_HXX_
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir //_______________________________________________
32*cdf0e10cSrcweir // include files of own module
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir #include <threadhelp/threadhelpbase.hxx>
35*cdf0e10cSrcweir #include <macros/debug.hxx>
36*cdf0e10cSrcweir #include <macros/generic.hxx>
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir #ifndef __FRAMEWORK_GENERAL_HXX_
39*cdf0e10cSrcweir #include <general.h>
40*cdf0e10cSrcweir #endif
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir //_______________________________________________
43*cdf0e10cSrcweir // include UNO interfaces
44*cdf0e10cSrcweir 
45*cdf0e10cSrcweir #ifndef _COM_SUN_STAR_URTIL_XUPDATABLE_HPP_
46*cdf0e10cSrcweir #include <com/sun/star/util/XUpdatable.hpp>
47*cdf0e10cSrcweir #endif
48*cdf0e10cSrcweir 
49*cdf0e10cSrcweir //_______________________________________________
50*cdf0e10cSrcweir // include all others
51*cdf0e10cSrcweir #include <cppuhelper/weakref.hxx>
52*cdf0e10cSrcweir #include <osl/thread.hxx>
53*cdf0e10cSrcweir 
54*cdf0e10cSrcweir //_______________________________________________
55*cdf0e10cSrcweir // namespace
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir namespace framework{
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir //_______________________________________________
60*cdf0e10cSrcweir // definitions
61*cdf0e10cSrcweir 
62*cdf0e10cSrcweir //===============================================
63*cdf0e10cSrcweir /** @short  implements a "sleeping" thread, which try to sleep
64*cdf0e10cSrcweir             without a using cpu consumption :-) */
65*cdf0e10cSrcweir class WakeUpThread : public ThreadHelpBase
66*cdf0e10cSrcweir                    , public ::osl::Thread
67*cdf0e10cSrcweir {
68*cdf0e10cSrcweir     //-------------------------------------------
69*cdf0e10cSrcweir     // member
70*cdf0e10cSrcweir     private:
71*cdf0e10cSrcweir 
72*cdf0e10cSrcweir         /** @short  this listener will be notified if this thread
73*cdf0e10cSrcweir                     waked up. */
74*cdf0e10cSrcweir         css::uno::WeakReference< css::util::XUpdatable > m_xListener;
75*cdf0e10cSrcweir 
76*cdf0e10cSrcweir     //-------------------------------------------
77*cdf0e10cSrcweir     // interface
78*cdf0e10cSrcweir     public:
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir         /** @short  Register a new listener on this thread.
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir             @descr  The listener is holded as a weak reference.
83*cdf0e10cSrcweir                     If the thread detects, that no listener exists ...
84*cdf0e10cSrcweir                     he will terminate itself.
85*cdf0e10cSrcweir          */
86*cdf0e10cSrcweir         WakeUpThread(const css::uno::Reference< css::util::XUpdatable >& xListener);
87*cdf0e10cSrcweir 
88*cdf0e10cSrcweir         /** @descr  The thread waits on a condition using a fix timeout value.
89*cdf0e10cSrcweir                     If the thread wakes up he notify the internal set listener.
90*cdf0e10cSrcweir                     The listener can use this "timeout" info for it's own purpose.
91*cdf0e10cSrcweir                     The thread itself will wait on the condition again.
92*cdf0e10cSrcweir          */
93*cdf0e10cSrcweir         virtual void SAL_CALL run();
94*cdf0e10cSrcweir 
95*cdf0e10cSrcweir         virtual void SAL_CALL onTerminated();
96*cdf0e10cSrcweir };
97*cdf0e10cSrcweir 
98*cdf0e10cSrcweir } // namespace framework
99*cdf0e10cSrcweir 
100*cdf0e10cSrcweir #endif // __FRAMEWORK_HELPER_WAKEUPTHREAD_HXX_
101