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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
//
// aegis - project change supervisor
// Copyright (C) 1991-1993, 2002, 2004-2006, 2008 Peter Miller.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see
// <http://www.gnu.org/licenses/>.
//
#ifndef LIBAEGIS_COMMIT_H
#define LIBAEGIS_COMMIT_H
/** \defgroup Transaction - meta-data database transactions
* \ingroup AegisLibrary
* \brief Functions to handle commit and rollback.
*
* Aegis implements transactions defining two operation
* queues, one is used to store operations to be run at commit time
* and the other is used to store operations to be run at rollback
* time.
*
* Operations to be run at commit time must be requested calling
* commit_* functions, while operations to be run at rollback time
* must be requested with undo_* functions.
*
* Note that operation requested with commit_/undo_ functions are not
* executed immediatly but are delayed until the proper event (commit
* or undo) is issued. Also note that it is possible that the
* operation you request (e.g. commit_rename) will not be executed
* because an undo event is triggered, the same holds for undo_ operation.
*
* @{
*/
struct string_ty; // forward
class nstring; // forward
/**
* The commit_rename function is used to
* submit a commit request to rename a file.
*
* \param from
* path of file now
* \param to
* path of file after commit
*/
void commit_rename(string_ty *from, string_ty *to);
/**
* The commit_rename function is used to
* submit a commit request to rename a file.
*
* \param from
* path of file now
* \param to
* path of file after commit
*/
void commit_rename(const nstring &from, const nstring &to);
/**
* The commit_symlink function is used to submit a commit request to
* symlink a file at commit (success) time.
*
* \param from
* path of file now
* \param to
* path of symlink to create at commit time.
*/
void commit_symlink(string_ty *from, string_ty *to);
/**
* The commit_symlink function is used to submit a commit request to
* symlink a file at commit (success) time.
*
* \param from
* path of file now
* \param to
* path of symlink to create at commit time.
*/
void commit_symlink(const nstring &from, const nstring &to);
/**
* The commit_hard_link function is used to submit a commit request to
* hard link a file at commit (success) time.
*
* \param from
* path of file now
* \param to
* path of hard link to create at commit time.
*/
void commit_hard_link(string_ty *from, string_ty *to);
/**
* The commit_hard_link function is used to submit a commit request to
* hard link a file at commit (success) time.
*
* \param from
* path of file now
* \param to
* path of hard link to create at commit time.
*/
void commit_hard_link(const nstring &from, const nstring &to);
/**
* The commit_unlink_errok function is used to unlink a file on
* commit. It will not be an error if the file does not exist.
*
* \param path
* path of file to be unlinked
*/
void commit_unlink_errok(string_ty *path);
/**
* The commit_unlink_errok function is used to unlink a file on
* commit. It will not be an error if the file does not exist.
*
* \param path
* path of file to be unlinked
*/
void commit_unlink_errok(const nstring &path);
/**
* The commit_rmdir_errok function is used to delete an empty
* directory on commit. It will not be an error if the directory
* does not exist. It will not be an error if the directory is not
* empty.
*
* \param path
* path of directory to be deleted
*/
void commit_rmdir_errok(string_ty *path);
/**
* The commit_rmdir_errok function is used to delete an empty
* directory on commit. It will not be an error if the directory
* does not exist. It will not be an error if the directory is not
* empty.
*
* \param path
* path of directory to be deleted
*/
void commit_rmdir_errok(const nstring &path);
/**
* The commit_rmdir_tree_bg function is used to delete a directory tree
* on commit. It will not be an error if the directory does not exist.
* It will not be an error if the directory, or any subtree, is not
* empty.
*
* \param path
* path of directory to be deleted
*/
void commit_rmdir_tree_bg(string_ty *path);
/**
* The commit_rmdir_tree_bg function is used to delete a directory tree
* on commit. It will not be an error if the directory does not exist.
* It will not be an error if the directory, or any subtree, is not
* empty.
*
* \param path
* path of directory to be deleted
*/
void commit_rmdir_tree_bg(const nstring &path);
/**
* The commit_rmdir_tree_errok function is used to delete a directory
* tree on commit. It will not be an error if the directory does not
* exist. It will not be an error if the directory, or any subtree,
* is not empty.
*
* \param path
* path of directory to be deleted
*/
void commit_rmdir_tree_errok(string_ty *path);
/**
* The commit_rmdir_tree_errok function is used to delete a directory
* tree on commit. It will not be an error if the directory does not
* exist. It will not be an error if the directory, or any subtree,
* is not empty.
*
* \param path
* path of directory to be deleted
*/
void commit_rmdir_tree_errok(const nstring &path);
/**
* The commit function is used to perform all the actions queued using
* the commit_* functions.
*
* After it has completed successfully, further calls to commit() will
* be NOPs, until new commit_* functions are used.
*
* When the commit has succeeded, the undo list is cancelled, since
* there is now no reason to undo anything.
*/
void commit(void);
/** @} */
#endif // LIBAEGIS_COMMIT_H
|
