1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef SD_ASYNCHRONOUS_CALL_HXX 25*b1cdbd2cSJim Jagielski #define SD_ASYNCHRONOUS_CALL_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <vcl/timer.hxx> 28*b1cdbd2cSJim Jagielski #include <memory> 29*b1cdbd2cSJim Jagielski #include <boost/function.hpp> 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski namespace sd { namespace tools { 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski /** Store a function object and execute it asynchronous. 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski The features of this class are: 37*b1cdbd2cSJim Jagielski a) It provides a wrapper around a VCL Timer so that generic function 38*b1cdbd2cSJim Jagielski objects can be used. 39*b1cdbd2cSJim Jagielski b) When more than one function objects are posted to be executed later 40*b1cdbd2cSJim Jagielski then the pending ones are erased and only the last one will actually be 41*b1cdbd2cSJim Jagielski executed. 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski Use this class like this: 44*b1cdbd2cSJim Jagielski aInstanceOfAsynchronousCall.Post( 45*b1cdbd2cSJim Jagielski ::boost::bind( 46*b1cdbd2cSJim Jagielski ::std::mem_fun(&DrawViewShell::SwitchPage), 47*b1cdbd2cSJim Jagielski pDrawViewShell, 48*b1cdbd2cSJim Jagielski 11)); 49*b1cdbd2cSJim Jagielski */ 50*b1cdbd2cSJim Jagielski class AsynchronousCall 51*b1cdbd2cSJim Jagielski { 52*b1cdbd2cSJim Jagielski public: 53*b1cdbd2cSJim Jagielski /** Create a new asynchronous call. Each object of this class processes 54*b1cdbd2cSJim Jagielski one (semantical) type of call. 55*b1cdbd2cSJim Jagielski */ 56*b1cdbd2cSJim Jagielski AsynchronousCall (void); 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski ~AsynchronousCall (void); 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski /** Post a function object that is to be executed asynchronously. When 61*b1cdbd2cSJim Jagielski this method is called while the current function object has not bee 62*b1cdbd2cSJim Jagielski executed then the later is destroyed and only the given function 63*b1cdbd2cSJim Jagielski object will be executed. 64*b1cdbd2cSJim Jagielski @param rFunction 65*b1cdbd2cSJim Jagielski The function object that may be called asynchronously in the 66*b1cdbd2cSJim Jagielski near future. 67*b1cdbd2cSJim Jagielski @param nTimeoutInMilliseconds 68*b1cdbd2cSJim Jagielski The timeout in milliseconds until the function object is 69*b1cdbd2cSJim Jagielski executed. 70*b1cdbd2cSJim Jagielski */ 71*b1cdbd2cSJim Jagielski typedef ::boost::function0<void> AsynchronousFunction; 72*b1cdbd2cSJim Jagielski void Post ( 73*b1cdbd2cSJim Jagielski const AsynchronousFunction& rFunction, 74*b1cdbd2cSJim Jagielski sal_uInt32 nTimeoutInMilliseconds=10); 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski private: 77*b1cdbd2cSJim Jagielski Timer maTimer; 78*b1cdbd2cSJim Jagielski /** The function object that will be executed when the TimerCallback 79*b1cdbd2cSJim Jagielski function is called the next time. This pointer may be NULL. 80*b1cdbd2cSJim Jagielski */ 81*b1cdbd2cSJim Jagielski ::std::auto_ptr<AsynchronousFunction> mpFunction; 82*b1cdbd2cSJim Jagielski DECL_LINK(TimerCallback,Timer*); 83*b1cdbd2cSJim Jagielski }; 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski } } // end of namespace ::sd::tools 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski #endif 89