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
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
namespace mongo {
class BSONObj;
class OperationContext;
class Status;
template <typename T>
class StatusWith;
enum class PrepareConflictBehavior;
namespace repl {
class ReadConcernArgs;
class SpeculativeMajorityReadInfo;
} // namespace repl
/**
* Sets the prepare conflict behavior for a command.
*
* If the prepareConflictBehavior requested is to ignore prepare conflicts, then readConcernArgs
* are used to verify if the command is safe to ignore prepare conflicts, and if not, we
* enforce prepare conflicts.
*/
void setPrepareConflictBehaviorForReadConcern(OperationContext* opCtx,
const repl::ReadConcernArgs& readConcernArgs,
PrepareConflictBehavior prepareConflictBehavior);
/**
* Given the specified read concern arguments, performs checks that the read concern can actually be
* satisfied given the current state of the server and if so calls into the replication subsystem to
* perform the wait. If allowAfterClusterTime is false returns an error if afterClusterTime is
* set on the readConcernArgs.
*
* Note: Callers should use setPrepareConflictBehaviorForReadConcern method to set the desired
* prepare conflict behavior for their command.
*/
Status waitForReadConcern(OperationContext* opCtx,
const repl::ReadConcernArgs& readConcernArgs,
bool allowAfterClusterTime);
/*
* Given a linearizable read command, confirm that
* current primary is still the true primary of the replica set.
*
* A readConcernTimeout of 0 indicates that the operation will block indefinitely waiting for read
* concern.
*/
Status waitForLinearizableReadConcern(OperationContext* opCtx, int readConcernTimeout);
/**
* Waits to satisfy a "speculative" majority read.
*
* This method must only be called if the operation is a speculative majority read.
*/
Status waitForSpeculativeMajorityReadConcern(OperationContext* opCtx,
repl::SpeculativeMajorityReadInfo speculativeReadInfo);
} // namespace mongo
|
