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 IINTERFACE_HXX_INCLUDED 25*b1cdbd2cSJim Jagielski #define IINTERFACE_HXX_INCLUDED 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <sal/types.h> 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski /** The base interface 30*b1cdbd2cSJim Jagielski */ 31*b1cdbd2cSJim Jagielski class IInterface 32*b1cdbd2cSJim Jagielski { 33*b1cdbd2cSJim Jagielski public: 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski /** Aquire a reference to an instance. A caller shall release 36*b1cdbd2cSJim Jagielski the instance by calling 'release' when it is no longer needed. 37*b1cdbd2cSJim Jagielski 'acquire' and 'release' calls need to be balanced. 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski @returns 40*b1cdbd2cSJim Jagielski the current reference count of the instance for debugging purposes. 41*b1cdbd2cSJim Jagielski */ 42*b1cdbd2cSJim Jagielski virtual sal_Int32 acquire() = 0; 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski /** Releases a reference to an instance. A caller has to call 45*b1cdbd2cSJim Jagielski 'release' when a before aquired reference to an instance 46*b1cdbd2cSJim Jagielski is no longer needed. 'acquire' and 'release' calls need to 47*b1cdbd2cSJim Jagielski be balanced. 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski @returns 50*b1cdbd2cSJim Jagielski the current reference count of the instance for debugging purposes. 51*b1cdbd2cSJim Jagielski */ 52*b1cdbd2cSJim Jagielski virtual sal_Int32 release() = 0; 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski /** Returns the current reference count. This method should be used for 55*b1cdbd2cSJim Jagielski debugging purposes. Using it otherwise is a signal of a design flaw. 56*b1cdbd2cSJim Jagielski */ 57*b1cdbd2cSJim Jagielski virtual sal_Int32 getReferenceCount() const = 0; 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski protected: ~IInterface()60*b1cdbd2cSJim Jagielski virtual ~IInterface() {}; 61*b1cdbd2cSJim Jagielski }; 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski #endif // IDOCUMENT_HXX_INCLUDED 64