| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef SD_ASYNCHRONOUS_CALL_HXX |
| #define SD_ASYNCHRONOUS_CALL_HXX |
| |
| #include <vcl/timer.hxx> |
| #include <memory> |
| #include <boost/function.hpp> |
| |
| namespace sd { namespace tools { |
| |
| |
| /** Store a function object and execute it asynchronous. |
| |
| The features of this class are: |
| a) It provides a wrapper around a VCL Timer so that generic function |
| objects can be used. |
| b) When more than one function objects are posted to be executed later |
| then the pending ones are erased and only the last one will actually be |
| executed. |
| |
| Use this class like this: |
| aInstanceOfAsynchronousCall.Post( |
| ::boost::bind( |
| ::std::mem_fun(&DrawViewShell::SwitchPage), |
| pDrawViewShell, |
| 11)); |
| */ |
| class AsynchronousCall |
| { |
| public: |
| /** Create a new asynchronous call. Each object of this class processes |
| one (semantical) type of call. |
| */ |
| AsynchronousCall (void); |
| |
| ~AsynchronousCall (void); |
| |
| /** Post a function object that is to be executed asynchronously. When |
| this method is called while the current function object has not bee |
| executed then the later is destroyed and only the given function |
| object will be executed. |
| @param rFunction |
| The function object that may be called asynchronously in the |
| near future. |
| @param nTimeoutInMilliseconds |
| The timeout in milliseconds until the function object is |
| executed. |
| */ |
| typedef ::boost::function0<void> AsynchronousFunction; |
| void Post ( |
| const AsynchronousFunction& rFunction, |
| sal_uInt32 nTimeoutInMilliseconds=10); |
| |
| private: |
| Timer maTimer; |
| /** The function object that will be executed when the TimerCallback |
| function is called the next time. This pointer may be NULL. |
| */ |
| ::std::auto_ptr<AsynchronousFunction> mpFunction; |
| DECL_LINK(TimerCallback,Timer*); |
| }; |
| |
| |
| } } // end of namespace ::sd::tools |
| |
| #endif |