summaryrefslogtreecommitdiff
path: root/csharp/AckPolicy.cs
blob: 9095c77f5bee62b030b8bfb22c40ff38e3fd6aec (plain)
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
/*-
 * See the file LICENSE for redistribution information.
 *
 * Copyright (c) 2009 Oracle.  All rights reserved.
 *
 */
using System;
using System.Collections.Generic;
using System.Text;
using BerkeleyDB.Internal;

namespace BerkeleyDB {
    /// <summary>
    /// The AckPolicy class specifies how master and client sites will handle
    /// acknowledgment of replication messages which are necessary for
    /// "permanent" records. The current implementation requires all sites in a
    /// replication group configure the same acknowledgement policy. 
    /// </summary>
    public class AckPolicy {
        private int _value;
        internal int Policy {
            get { return _value; }
            private set { _value = value; }
        }

        private AckPolicy(int policyValue) {
            Policy = policyValue;
        }

        internal static AckPolicy fromInt(int value) {
            switch (value) {
                case 0:
                    return null;
                case DbConstants.DB_REPMGR_ACKS_ALL:
                    return ALL;
                case DbConstants.DB_REPMGR_ACKS_ALL_PEERS:
                    return ALL_PEERS;
                case DbConstants.DB_REPMGR_ACKS_NONE:
                    return NONE;
                case DbConstants.DB_REPMGR_ACKS_ONE:
                    return ONE;
                case DbConstants.DB_REPMGR_ACKS_ONE_PEER:
                    return ONE_PEER;
                case DbConstants.DB_REPMGR_ACKS_QUORUM:
                    return QUORUM;
                default:
                    throw new ArgumentException("Unknown AckPolicy value.");
            }
        }
        /// <summary>
        /// The master should wait until all replication clients have
        /// acknowledged each permanent replication message.
        /// </summary>
        public static AckPolicy ALL =
            new AckPolicy(DbConstants.DB_REPMGR_ACKS_ALL);
        /// <summary>
        /// The master should wait until all electable peers have acknowledged
        /// each permanent replication message (where "electable peer" means a
        /// client capable of being subsequently elected master of the
        /// replication group).
        /// </summary>
        public static AckPolicy ALL_PEERS =
            new AckPolicy(DbConstants.DB_REPMGR_ACKS_ALL_PEERS);
        /// <summary>
        /// The master should not wait for any client replication message
        /// acknowledgments.
        /// </summary>
        public static AckPolicy NONE =
            new AckPolicy(DbConstants.DB_REPMGR_ACKS_NONE);
        /// <summary>
        /// The master should wait until at least one client site has
        /// acknowledged each permanent replication message. 
        /// </summary>
        public static AckPolicy ONE =
            new AckPolicy(DbConstants.DB_REPMGR_ACKS_ONE);
        /// <summary>
        /// The master should wait until at least one electable peer has
        /// acknowledged each permanent replication message (where "electable
        /// peer" means a client capable of being subsequently elected master of
        /// the replication group).
        /// </summary>
        public static AckPolicy ONE_PEER =
              new AckPolicy(DbConstants.DB_REPMGR_ACKS_ONE_PEER);
        /// <summary>
        /// The master should wait until it has received acknowledgements from
        /// the minimum number of electable peers sufficient to ensure that the
        /// effect of the permanent record remains durable if an election is
        /// held (where "electable peer" means a client capable of being
        /// subsequently elected master of the replication group). This is the
        /// default acknowledgement policy.
        /// </summary>
        public static AckPolicy QUORUM =
              new AckPolicy(DbConstants.DB_REPMGR_ACKS_QUORUM);
    }
}