1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
#ifndef INCLUDED_FRAMEWORK_INC_THREADHELP_TRANSACTIONGUARD_HXX
#define INCLUDED_FRAMEWORK_INC_THREADHELP_TRANSACTIONGUARD_HXX
#include <threadhelp/inoncopyable.h>
#include <threadhelp/itransactionmanager.h>
namespace framework{
/*-************************************************************************************************************//**
@short implement a guard to support non breakable transactions
@descr If you wish to support non breakable method calls without lockingf any mutex, rw-lock or
something like that - you should use this guard implementation.
Initialize it at first in your method and don't release it till end of your function!
Your "transaction" is registered in ctor and automaticly released in dtor.
Use set/get of working mode to enable/disable further transactions.
It's possible too, to enable automaticly throwing of some exceptions for illegal
transaction requests ... e.g. interface call for already disposed objects.
@attention To prevent us against wrong using, the default ctor, copy ctor and the =operator are maked private!
@implements -
@base INonCopyable
@devstatus draft
*//*-*************************************************************************************************************/
class TransactionGuard : private INonCopyable
{
//-------------------------------------------------------------------------------------------------------------
// public methods
//-------------------------------------------------------------------------------------------------------------
public:
/*-****************************************************************************************************//**
@short ctors
@descr Use these ctor methods to initialize the guard right.
Given reference must be valid - otherwise crashes could occur!
@attention It's not necessary to lock any mutex here! Because a ctor should not be called
from different threads at the same time ... this class use no refcount mechanism!
@seealso -
@param "rManager" reference to transaction manager for using to register a request
@param "eMode" enable/disable throwing of exceptions for rejected calls
@param "eReason" returns reason for rejected calls if "eMode=E_NOEXCEPTIONS"!
@return -
@onerror -
*//*-*****************************************************************************************************/
inline TransactionGuard( ITransactionManager& rManager, EExceptionMode eMode, ERejectReason* eReason = NULL )
: m_pManager( &rManager )
{
// If exception mode is set to E_HARDEXCETIONS we don't need a buffer to return reason!
// We handle it private. If a call is rejected, our manager throw some exceptions ... and the reason
// could be ignorable ...
if( eReason == NULL )
{
ERejectReason eMyReason;
m_pManager->registerTransaction( eMode, eMyReason );
}
else
{
m_pManager->registerTransaction( eMode, *eReason );
}
}
/*-************************************************************************************************************//**
@short dtor
@descr We must release the transaction manager and can forget his pointer.
@seealso -
@param -
@return -
@onerror -
*//*-*************************************************************************************************************/
inline ~TransactionGuard()
{
stop();
}
/*-************************************************************************************************************//**
@short stop current transaction
@descr We must release the transaction manager and can forget his pointer.
@attention We don't support any start() method here - because it is not easy to
detect if a transaction already started or not!
(combination of EExceptionMode and ERejectReason)
@seealso -
@param -
@return -
@onerror -
*//*-*************************************************************************************************************/
inline void stop()
{
if( m_pManager != NULL )
{
m_pManager->unregisterTransaction();
m_pManager = NULL;
}
}
//-------------------------------------------------------------------------------------------------------------
// private methods
//-------------------------------------------------------------------------------------------------------------
private:
/*-****************************************************************************************************//**
@short disable using of these functions!
@descr It's not allowed to use this methods. Different problem can occur otherwise.
Thats why we disable it by make it private.
@seealso other ctor
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
TransactionGuard();
//-------------------------------------------------------------------------------------------------------------
// private member
//-------------------------------------------------------------------------------------------------------------
private:
ITransactionManager* m_pManager ; /// pointer to safed transaction manager
}; // class TransactionGuard
} // namespace framework
#endif // INCLUDED_FRAMEWORK_INC_THREADHELP_TRANSACTIONGUARD_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
