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_FRAMEWORK_CHANGE_REQUEST_QUEUE_PROCESSOR_HXX 25*b1cdbd2cSJim Jagielski #define SD_FRAMEWORK_CHANGE_REQUEST_QUEUE_PROCESSOR_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include "ChangeRequestQueue.hxx" 28*b1cdbd2cSJim Jagielski #include <osl/mutex.hxx> 29*b1cdbd2cSJim Jagielski #include <rtl/ref.hxx> 30*b1cdbd2cSJim Jagielski #include <com/sun/star/drawing/framework/XConfigurationChangeRequest.hpp> 31*b1cdbd2cSJim Jagielski #include <com/sun/star/drawing/framework/ConfigurationChangeEvent.hpp> 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski #include <cppuhelper/interfacecontainer.hxx> 34*b1cdbd2cSJim Jagielski #include <tools/link.hxx> 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski #include <boost/shared_ptr.hpp> 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski namespace sd { namespace framework { 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski class ConfigurationController; 41*b1cdbd2cSJim Jagielski class ConfigurationUpdater; 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski /** The ChangeRequestQueueProcessor ownes the ChangeRequestQueue and 44*b1cdbd2cSJim Jagielski processes the configuration change requests. 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski When after processing one entry the queue is empty then the 47*b1cdbd2cSJim Jagielski XConfigurationController::update() method is called so that the changes 48*b1cdbd2cSJim Jagielski made to the local XConfiguration reference are reflected by the UI. 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski Queue entries are processed asynchronously by calling PostUserEvent(). 51*b1cdbd2cSJim Jagielski */ 52*b1cdbd2cSJim Jagielski class ChangeRequestQueueProcessor 53*b1cdbd2cSJim Jagielski { 54*b1cdbd2cSJim Jagielski public: 55*b1cdbd2cSJim Jagielski /** The queue processor is created with a reference to an 56*b1cdbd2cSJim Jagielski ConfigurationController so that its UpdateConfiguration() method can 57*b1cdbd2cSJim Jagielski be called when the queue becomes empty. 58*b1cdbd2cSJim Jagielski */ 59*b1cdbd2cSJim Jagielski ChangeRequestQueueProcessor ( 60*b1cdbd2cSJim Jagielski const ::rtl::Reference<ConfigurationController>& rxController, 61*b1cdbd2cSJim Jagielski const ::boost::shared_ptr<ConfigurationUpdater>& rpUpdater); 62*b1cdbd2cSJim Jagielski ~ChangeRequestQueueProcessor (void); 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski /** Sets the configuration who will be changed by subsequent change 65*b1cdbd2cSJim Jagielski requests. This method should be called only by the configuration 66*b1cdbd2cSJim Jagielski controller who owns the configuration. 67*b1cdbd2cSJim Jagielski */ 68*b1cdbd2cSJim Jagielski void SetConfiguration ( 69*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference< 70*b1cdbd2cSJim Jagielski ::com::sun::star::drawing::framework::XConfiguration>& rxConfiguration); 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski /** The given request is appended to the end of the queue and will 73*b1cdbd2cSJim Jagielski eventually be processed when all other entries in front of it have 74*b1cdbd2cSJim Jagielski been processed. 75*b1cdbd2cSJim Jagielski */ 76*b1cdbd2cSJim Jagielski void AddRequest (const ::com::sun::star::uno::Reference< 77*b1cdbd2cSJim Jagielski ::com::sun::star::drawing::framework::XConfigurationChangeRequest>& rxRequest); 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski /** Returns </sal_True> when the queue is empty. 80*b1cdbd2cSJim Jagielski */ 81*b1cdbd2cSJim Jagielski bool IsEmpty (void) const; 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski /** Process all events in the queue synchronously. 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski <p>This method is typically called when the framework is shut down 86*b1cdbd2cSJim Jagielski to establish an empty configuration.</p> 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski void ProcessUntilEmpty (void); 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski /** Process the first event in queue. 91*b1cdbd2cSJim Jagielski */ 92*b1cdbd2cSJim Jagielski void ProcessOneEvent (void); 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski /** Remove all events from the queue. 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski <p>This method is typically called when the framework is shut down 97*b1cdbd2cSJim Jagielski to avoid the processing of still pending activation requests.</p> 98*b1cdbd2cSJim Jagielski */ 99*b1cdbd2cSJim Jagielski void Clear (void); 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski private: 102*b1cdbd2cSJim Jagielski mutable ::osl::Mutex maMutex; 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski ChangeRequestQueue maQueue; 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski /** The id returned by the last PostUserEvent() call. This id is stored 107*b1cdbd2cSJim Jagielski so that a pending user event can be removed whent he queue processor 108*b1cdbd2cSJim Jagielski is destroyed. 109*b1cdbd2cSJim Jagielski */ 110*b1cdbd2cSJim Jagielski sal_uIntPtr mnUserEventId; 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Reference< 113*b1cdbd2cSJim Jagielski ::com::sun::star::drawing::framework::XConfiguration> mxConfiguration; 114*b1cdbd2cSJim Jagielski 115*b1cdbd2cSJim Jagielski ::rtl::Reference<ConfigurationController> mpConfigurationController; 116*b1cdbd2cSJim Jagielski 117*b1cdbd2cSJim Jagielski ::boost::shared_ptr<ConfigurationUpdater> mpConfigurationUpdater; 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski /** Initiate the processing of the entries in the queue. The actual 120*b1cdbd2cSJim Jagielski processing starts asynchronously. 121*b1cdbd2cSJim Jagielski */ 122*b1cdbd2cSJim Jagielski void StartProcessing (void); 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski /** Callback function for the PostUserEvent() call. 125*b1cdbd2cSJim Jagielski */ 126*b1cdbd2cSJim Jagielski DECL_LINK(ProcessEvent,void*); 127*b1cdbd2cSJim Jagielski }; 128*b1cdbd2cSJim Jagielski 129*b1cdbd2cSJim Jagielski 130*b1cdbd2cSJim Jagielski } } // end of namespace sd::framework 131*b1cdbd2cSJim Jagielski 132*b1cdbd2cSJim Jagielski #endif 133