1*408a4873SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*408a4873SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*408a4873SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*408a4873SAndrew Rist * distributed with this work for additional information 6*408a4873SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*408a4873SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*408a4873SAndrew Rist * "License"); you may not use this file except in compliance 9*408a4873SAndrew Rist * with the License. You may obtain a copy of the License at 10*408a4873SAndrew Rist * 11*408a4873SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*408a4873SAndrew Rist * 13*408a4873SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*408a4873SAndrew Rist * software distributed under the License is distributed on an 15*408a4873SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*408a4873SAndrew Rist * KIND, either express or implied. See the License for the 17*408a4873SAndrew Rist * specific language governing permissions and limitations 18*408a4873SAndrew Rist * under the License. 19*408a4873SAndrew Rist * 20*408a4873SAndrew Rist *************************************************************/ 21*408a4873SAndrew Rist 22*408a4873SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_uno_XUnloadingPreference_idl__ 24cdf0e10cSrcweir#define __com_sun_star_uno_XUnloadingPreference_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir//============================================================================= 31cdf0e10cSrcweir 32cdf0e10cSrcweirmodule com { module sun { module star { module uno { 33cdf0e10cSrcweir 34cdf0e10cSrcweir//============================================================================= 35cdf0e10cSrcweir/** Components can implement <code>XUnloadingPreference</code> in order to indicate 36cdf0e10cSrcweir how they should be treated when their hosting library is to be unloaded. 37cdf0e10cSrcweir 38cdf0e10cSrcweir When someone calls <code>rtl_unloadUnusedModules</code> then the unloading 39cdf0e10cSrcweir listeners are notified by calling previously registered callback 40cdf0e10cSrcweir functions. A listener is an entity that employs, registers, and 41cdf0e10cSrcweir unregisters the callback functions on its behalf. Upon notification 42cdf0e10cSrcweir (the callback function is being called) 43cdf0e10cSrcweir a listener may release references to UNO components. Thus, the 44cdf0e10cSrcweir loaded libraries can be unloaded, if no one else keeps any 45cdf0e10cSrcweir objects from the library alive. <br> 46cdf0e10cSrcweir Before a listener releases references, it should ask for this interface. 47cdf0e10cSrcweir If the interface is not implemented, then the listener may release the 48cdf0e10cSrcweir object; otherwise, it calls <code>releaseOnNotification</code>. If the function 49cdf0e10cSrcweir returns false then the listener should keep the reference, otherwise 50cdf0e10cSrcweir it may release it. 51cdf0e10cSrcweir*/ 52cdf0e10cSrcweirpublished interface XUnloadingPreference: com::sun::star::uno::XInterface 53cdf0e10cSrcweir{ 54cdf0e10cSrcweir /** 55cdf0e10cSrcweir The return value determines if the object wants to stay 56cdf0e10cSrcweir alive in case of an unloading procedure. 57cdf0e10cSrcweir @return 58cdf0e10cSrcweir <FALSE/>do not release references to this object,otherwise 59cdf0e10cSrcweir <TRUE/> 60cdf0e10cSrcweir */ 61cdf0e10cSrcweir boolean releaseOnNotification(); 62cdf0e10cSrcweir}; 63cdf0e10cSrcweir//============================================================================= 64cdf0e10cSrcweir 65cdf0e10cSrcweir}; }; }; }; 66cdf0e10cSrcweir 67cdf0e10cSrcweir#endif 68