-
Notifications
You must be signed in to change notification settings - Fork 161
/
Transaction.cs
87 lines (78 loc) · 2.77 KB
/
Transaction.cs
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
////////////////////////////////////////////////////////////////////////////
//
// Copyright 2016 Realm Inc.
//
// Licensed 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.
//
////////////////////////////////////////////////////////////////////////////
using System;
namespace Realms
{
/// <summary>
/// Provides a scope to safely read and write to a <see cref="Realm"/>. Must use explicitly via <see cref="Realm.BeginWrite"/>.
/// </summary>
/// <remarks>
/// All access to a <see cref="Realm"/> occurs within a <see cref="Transaction"/>. Read transactions are created implicitly.
/// </remarks>
public class Transaction : IDisposable
{
private readonly Realm _realm;
private bool _isOpen;
internal Transaction(Realm realm)
{
_realm = realm;
realm.SharedRealmHandle.BeginTransaction();
_isOpen = true;
}
/// <summary>
/// Will automatically <see cref="Rollback"/> the transaction on existing scope, if not explicitly Committed.
/// </summary>
public void Dispose()
{
GC.SuppressFinalize(this);
if (!_isOpen)
{
return;
}
Rollback();
}
/// <summary>
/// Use explicitly to undo the changes in a <see cref="Transaction"/>, otherwise it is automatically invoked by
/// exiting the block.
/// </summary>
public void Rollback()
{
if (!_isOpen)
{
throw new Exception("Transaction was already closed. Cannot roll back");
}
_realm.SharedRealmHandle.CancelTransaction();
_isOpen = false;
_realm.DrainTransactionQueue();
}
/// <summary>
/// Use to save the changes to the realm. If <see cref="Transaction"/> is declared in a <c>using</c> block,
/// must be used before the end of that block.
/// </summary>
public void Commit()
{
if (!_isOpen)
{
throw new Exception("Transaction was already closed. Cannot commit");
}
_realm.SharedRealmHandle.CommitTransaction();
_isOpen = false;
_realm.DrainTransactionQueue();
}
}
}