| /************************************************************** | |
| * | |
| * 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 __FRAMEWORK_THREADHELP_ITRANSACTIONMANAGER_H_ | |
| #define __FRAMEWORK_THREADHELP_ITRANSACTIONMANAGER_H_ | |
| //_________________________________________________________________________________________________________________ | |
| // includes | |
| //_________________________________________________________________________________________________________________ | |
| #include <general.h> | |
| #include <com/sun/star/uno/RuntimeException.hpp> | |
| #include <com/sun/star/lang/DisposedException.hpp> | |
| //_________________________________________________________________________________________________________________ | |
| // namespace | |
| //_________________________________________________________________________________________________________________ | |
| namespace framework{ | |
| //_________________________________________________________________________________________________________________ | |
| // declarations | |
| //_________________________________________________________________________________________________________________ | |
| /*-************************************************************************************************************//** | |
| @descr Describe different states of a feature of following implementation. | |
| During live time of an object different working states occur: | |
| initialization - working - closing - closed | |
| If you whish to implement thread safe classes you should use these feature to protect | |
| your code against calls at wrong time. e.g. you are not full initialized but somewhere | |
| call an interface method (initialize phase means startup time from creating object till | |
| calling specified first method e.g. XInitialization::initialize()!) then you should refuse | |
| this call. The same for closing/disposing the object! | |
| *//*-*************************************************************************************************************/ | |
| enum EWorkingMode | |
| { | |
| E_INIT , // We stand in a init method -> some calls are accepted - some one are rejected | |
| E_WORK , // Object is ready for working -> all calls are accepted | |
| E_BEFORECLOSE, // We stand in a close method -> some calls are accepted - some one are rejected | |
| E_CLOSE // Object is dead! -> all calls are rejected! | |
| }; | |
| /*-************************************************************************************************************//** | |
| @descr If a request was refused by a transaction manager (internal state different E_WORK ...) | |
| user can check the reason by using this enum values. | |
| *//*-*************************************************************************************************************/ | |
| enum ERejectReason | |
| { | |
| E_UNINITIALIZED , | |
| E_NOREASON , | |
| E_INCLOSE , | |
| E_CLOSED | |
| }; | |
| /*-************************************************************************************************************//** | |
| @descr A transaction object should support throwing exceptions if user used it at wrong working mode. | |
| e.g. We can throw a DisposedException if user try to work and our mode is E_CLOSE! | |
| But sometimes he dont need this feature - will handle it by himself. | |
| Then we must differ between some exception-modi: | |
| E_NOEXCEPTIONS We never throw any exceptions! User handle it private and looks for ERejectReason. | |
| E_HARDEXCEPTIONS We throw exceptions for all working modes different from E_WORK! | |
| E_SOFTEXCEPTIONS We throw exceptions for all working modes different from E_WORK AND E_INCLOSE! | |
| This mode is useful for impl-methods which should be callable from dispose() method! | |
| e.g. void dispose() | |
| { | |
| m_aTransactionManager.setWorkingMode( E_BEFORECLOSE ); | |
| ... | |
| impl_setA( 0 ); | |
| ... | |
| m_aTransactionManager.setWorkingMode( E_CLOSE ); | |
| } | |
| void impl_setA( int nA ) | |
| { | |
| ERejectReason EReason; | |
| TransactionGuard aTransactionGuard( m_aTransactionManager, E_SOFTEXCEPTIONS, eReason ); | |
| m_nA = nA; | |
| } | |
| Normally (if E_HARDEXCEPTIONS was used!) creation of guard | |
| will throw an exception ... but using of E_SOFTEXCEPTIONS suppress it | |
| and member "A" can be set. | |
| *//*-*************************************************************************************************************/ | |
| enum EExceptionMode | |
| { | |
| E_NOEXCEPTIONS , | |
| E_HARDEXCEPTIONS, | |
| E_SOFTEXCEPTIONS | |
| }; | |
| /*-************************************************************************************************************//** | |
| @descr How can you use the transaction manager? | |
| Use it in combination with an TransactionGuard, which register your transaction in ctor | |
| and release in dtor automatically! Follow interface class can be used to make using | |
| of different manager implementations possible by using same guard. | |
| *//*-*************************************************************************************************************/ | |
| class ITransactionManager | |
| { | |
| //------------------------------------------------------------------------------------------------------------- | |
| // public methods | |
| //------------------------------------------------------------------------------------------------------------- | |
| public: | |
| /*-****************************************************************************************************//** | |
| @descr These functions must be supported by a derived class! | |
| getWorkingMode() -return current set working mode | |
| setWorkingMode() -change working mode | |
| (This will block till all current transactions are finished!) | |
| isCallRejected() -test method to check if a call will be rejected by wrong working mode or not | |
| registerTransaction() -start new transaction (increase internal transaction count) | |
| unregisterTransaction() -finish transaction (decrease internal transaction count) | |
| *//*-*****************************************************************************************************/ | |
| virtual EWorkingMode getWorkingMode ( ) const = 0; | |
| virtual void setWorkingMode ( EWorkingMode eMode ) = 0; | |
| virtual sal_Bool isCallRejected ( ERejectReason& eReason ) const = 0; | |
| virtual void registerTransaction ( EExceptionMode eMode , ERejectReason& eReason ) = 0; | |
| virtual void unregisterTransaction ( ) = 0; | |
| }; // class ITransactionManager | |
| } // namespace framework | |
| #endif // #ifndef __FRAMEWORK_THREADHELP_ITRANSACTIONMANAGER_H_ |