1 /************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24 #ifndef __FRAMEWORK_THREADHELP_IGUARD_H_ 25 #define __FRAMEWORK_THREADHELP_IGUARD_H_ 26 27 //_________________________________________________________________________________________________________________ 28 // includes 29 //_________________________________________________________________________________________________________________ 30 31 #include <sal/types.h> 32 33 //_________________________________________________________________________________________________________________ 34 // namespace 35 //_________________________________________________________________________________________________________________ 36 37 namespace framework{ 38 39 //_________________________________________________________________________________________________________________ 40 // declarations 41 //_________________________________________________________________________________________________________________ 42 43 /*-************************************************************************************************************//** 44 @descr interface for guarding a lock 45 *//*-*************************************************************************************************************/ 46 class SAL_NO_VTABLE IGuard 47 { 48 //------------------------------------------------------------------------------------------------------------- 49 // public methods 50 //------------------------------------------------------------------------------------------------------------- 51 public: 52 53 /** clears the lock. If the guard does not currently hold the lock, nothing happens. 54 */ 55 virtual void clear() = 0; 56 57 /** attempts to re-establishes the lock, blocking until the attempt is successful. 58 */ 59 virtual void reset() = 0; 60 61 }; // class IGuard 62 63 } // namespace framework 64 65 #endif // #ifndef __FRAMEWORK_THREADHELP_IGUARD_H_ 66