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 SD_ASYNCHRONOUS_CALL_HXX
29*cdf0e10cSrcweir #define SD_ASYNCHRONOUS_CALL_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <vcl/timer.hxx>
32*cdf0e10cSrcweir #include <memory>
33*cdf0e10cSrcweir #include <boost/function.hpp>
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir namespace sd { namespace tools {
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir /** Store a function object and execute it asynchronous.
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir     The features of this class are:
41*cdf0e10cSrcweir     a) It provides a wrapper around a VCL Timer so that generic function
42*cdf0e10cSrcweir     objects can be used.
43*cdf0e10cSrcweir     b) When more than one function objects are posted to be executed later
44*cdf0e10cSrcweir     then the pending ones are erased and only the last one will actually be
45*cdf0e10cSrcweir     executed.
46*cdf0e10cSrcweir 
47*cdf0e10cSrcweir     Use this class like this:
48*cdf0e10cSrcweir     aInstanceOfAsynchronousCall.Post(
49*cdf0e10cSrcweir         ::boost::bind(
50*cdf0e10cSrcweir             ::std::mem_fun(&DrawViewShell::SwitchPage),
51*cdf0e10cSrcweir             pDrawViewShell,
52*cdf0e10cSrcweir             11));
53*cdf0e10cSrcweir */
54*cdf0e10cSrcweir class AsynchronousCall
55*cdf0e10cSrcweir {
56*cdf0e10cSrcweir public:
57*cdf0e10cSrcweir     /** Create a new asynchronous call.  Each object of this class processes
58*cdf0e10cSrcweir         one (semantical) type of call.
59*cdf0e10cSrcweir     */
60*cdf0e10cSrcweir     AsynchronousCall (void);
61*cdf0e10cSrcweir 
62*cdf0e10cSrcweir     ~AsynchronousCall (void);
63*cdf0e10cSrcweir 
64*cdf0e10cSrcweir     /** Post a function object that is to be executed asynchronously.  When
65*cdf0e10cSrcweir         this method is called while the current function object has not bee
66*cdf0e10cSrcweir         executed then the later is destroyed and only the given function
67*cdf0e10cSrcweir         object will be executed.
68*cdf0e10cSrcweir         @param rFunction
69*cdf0e10cSrcweir             The function object that may be called asynchronously in the
70*cdf0e10cSrcweir             near future.
71*cdf0e10cSrcweir         @param nTimeoutInMilliseconds
72*cdf0e10cSrcweir             The timeout in milliseconds until the function object is
73*cdf0e10cSrcweir             executed.
74*cdf0e10cSrcweir     */
75*cdf0e10cSrcweir     typedef ::boost::function0<void> AsynchronousFunction;
76*cdf0e10cSrcweir     void Post (
77*cdf0e10cSrcweir         const AsynchronousFunction& rFunction,
78*cdf0e10cSrcweir         sal_uInt32 nTimeoutInMilliseconds=10);
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir private:
81*cdf0e10cSrcweir     Timer maTimer;
82*cdf0e10cSrcweir     /** The function object that will be executed when the TimerCallback
83*cdf0e10cSrcweir         function is called the next time.  This pointer may be NULL.
84*cdf0e10cSrcweir     */
85*cdf0e10cSrcweir     ::std::auto_ptr<AsynchronousFunction> mpFunction;
86*cdf0e10cSrcweir     DECL_LINK(TimerCallback,Timer*);
87*cdf0e10cSrcweir };
88*cdf0e10cSrcweir 
89*cdf0e10cSrcweir 
90*cdf0e10cSrcweir } } // end of namespace ::sd::tools
91*cdf0e10cSrcweir 
92*cdf0e10cSrcweir #endif
93