modules/platforms/dotnet/Apache.Ignite.Core/DataStructures/Configuration/AtomicConfiguration.cs

/*
 * 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.
 */

namespace Apache.Ignite.Core.DataStructures.Configuration
{
    using System.ComponentModel;
    using Apache.Ignite.Core.Cache.Configuration;

    /// <summary>
    /// Configuration for atomic data structures.
    /// </summary>
    public class AtomicConfiguration
    {
        /// <summary> Default number of backups. </summary>
        public const int DefaultBackups = 0;

        /// <summary> Default caching mode. </summary>
        public const CacheMode DefaultCacheMode = CacheMode.Partitioned;

        /// <summary> Default atomic sequence reservation size. </summary>
        public const int DefaultAtomicSequenceReserveSize = 1000;

        /// <summary>
        /// Gets or sets number of nodes used to back up single partition for 
        /// <see cref="Cache.Configuration.CacheMode.Partitioned"/> cache.
        /// </summary>
        [DefaultValue(DefaultBackups)]
        public int Backups { get; set; }

        /// <summary>
        /// Gets or sets caching mode to use.
        /// </summary>
        [DefaultValue(DefaultCacheMode)]
        public CacheMode CacheMode { get; set; }

        /// <summary>
        /// Gets or sets the default number of sequence values reserved for <see cref="IAtomicSequence"/> instances. 
        /// After a certain number has been reserved, consequent increments of sequence will happen locally,
        /// without communication with other nodes, until the next reservation has to be made. 
        /// </summary>
        [DefaultValue(DefaultAtomicSequenceReserveSize)]
        public int AtomicSequenceReserveSize { get; set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="AtomicConfiguration" /> class.
        /// </summary>
        public AtomicConfiguration()
        {
            CacheMode = DefaultCacheMode;
            AtomicSequenceReserveSize = DefaultAtomicSequenceReserveSize;
        }
    }
}