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
|
# Copyright (C) 2015 MongoDB, 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.
require 'mongo/write_concern/normalizable'
require 'mongo/write_concern/acknowledged'
require 'mongo/write_concern/unacknowledged'
module Mongo
# Base module for all write concern specific behaviour.
#
# @since 2.0.0
module WriteConcern
extend self
# The number of servers write concern.
#
# @since 2.0.0
W = :w.freeze
# The journal write concern.
#
# @since 2.0.0
J = :j.freeze
# The file sync write concern.
#
# @since 2.0.0
FSYNC = :fsync.freeze
# The wtimeout write concern.
#
# @since 2.0.0
WTIMEOUT = :wtimeout.freeze
# The GLE command name.
#
# @since 2.0.0
GET_LAST_ERROR = :getlasterror.freeze
# The default write concern is to acknowledge on a single server.
#
# @since 2.0.0
DEFAULT = { }.freeze
# Get a write concern mode for the provided options.
#
# @example Get a write concern mode.
# Mongo::WriteConcern.get(:w => 1)
#
# @param [ Hash ] options The options to instantiate with.
#
# @option options :w [ Integer, String ] The number of servers or the
# custom mode to acknowledge.
# @option options :j [ true, false ] Whether to acknowledge a write to
# the journal.
# @option options :fsync [ true, false ] Should the write be synced to
# disc.
# @option options :wtimeout [ Integer ] The number of milliseconds to
# wait for acknowledgement before raising an error.
#
# @return [ Unacknowledged, Acknowledged ] The appropriate concern.
#
# @raise [ Error::InvalidWriteConcern ] If the write concern is invalid.
#
# @since 2.0.0
def get(options)
return options if options.is_a?(Unacknowledged) || options.is_a?(Acknowledged)
if options
validate!(options)
if unacknowledged?(options)
Unacknowledged.new(options)
else
Acknowledged.new(options)
end
end
end
private
def validate!(options)
if options[W]
if options[W] == 0 && (options[J] || options[FSYNC])
raise Mongo::Error::InvalidWriteConcern.new
elsif options[W].is_a?(Integer) && options[W] < 0
raise Mongo::Error::InvalidWriteConcern.new
end
end
end
# Determine if the options are for an unacknowledged write concern.
#
# @api private
#
# @param [ Hash ] options The options to check.
#
# @return [ true, false ] If the options are unacknowledged.
#
# @since 2.0.0
def unacknowledged?(options)
options[W] == 0
end
end
end
|
