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
|
/**
* 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
#include <boost/optional.hpp>
#include <string>
#include "mongo/base/status.h"
#include "mongo/base/status_with.h"
#include "mongo/db/clientcursor.h"
#include "mongo/db/namespace_string.h"
#include "mongo/util/time_support.h"
namespace mongo {
struct GetMoreRequest {
static const char kGetMoreCommandName[];
/**
* Construct an empty request.
*/
GetMoreRequest();
/**
* Construct from values for each field.
*/
GetMoreRequest(NamespaceString namespaceString,
CursorId id,
boost::optional<std::int64_t> sizeOfBatch,
boost::optional<Milliseconds> awaitDataTimeout,
boost::optional<long long> term,
boost::optional<repl::OpTime> lastKnownCommittedOpTime);
/**
* Construct a GetMoreRequest from the command specification and db name.
*/
static StatusWith<GetMoreRequest> parseFromBSON(const std::string& dbname,
const BSONObj& cmdObj);
/**
* Serializes this object into a BSON representation. Fields that are not set will not be
* part of the the serialized object.
*/
BSONObj toBSON() const;
const NamespaceString nss;
const CursorId cursorid;
// The batch size is optional. If not provided, we will put as many documents into the batch
// as fit within the byte limit.
const boost::optional<std::int64_t> batchSize;
// The number of milliseconds for which a getMore on a tailable, awaitData query should block.
const boost::optional<Milliseconds> awaitDataTimeout;
// Only internal queries from replication will typically have a term.
const boost::optional<long long> term;
// Only internal queries from replication will have a last known committed optime.
const boost::optional<repl::OpTime> lastKnownCommittedOpTime;
private:
/**
* Returns a non-OK status if there are semantic errors in the parsed request
* (e.g. a negative batchSize).
*/
Status isValid() const;
};
} // namespace mongo
|
