Transaction.cs

////////////////////////////////////////////////////////////////////////////
//
// 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();
        }
    }
}