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
116
|
/**
* 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 <iosfwd>
#include <string>
#include "mongo/db/jsobj.h"
#include "mongo/rpc/metadata.h"
#include "mongo/transport/transport_layer.h"
#include "mongo/util/net/hostandport.h"
#include "mongo/util/time_support.h"
namespace mongo {
namespace executor {
/**
* Type of object describing a command to execute against a remote MongoDB node.
*/
struct RemoteCommandRequest {
// Indicates that there is no timeout for the request to complete
static constexpr Milliseconds kNoTimeout{-1};
// Indicates that there is no expiration time by when the request needs to complete
static constexpr Date_t kNoExpirationDate{Date_t::max()};
// Type to represent the internal id of this request
typedef uint64_t RequestId;
RemoteCommandRequest();
RemoteCommandRequest(RequestId requestId,
const HostAndPort& theTarget,
const std::string& theDbName,
const BSONObj& theCmdObj,
const BSONObj& metadataObj,
OperationContext* opCtx,
Milliseconds timeoutMillis);
RemoteCommandRequest(const HostAndPort& theTarget,
const std::string& theDbName,
const BSONObj& theCmdObj,
const BSONObj& metadataObj,
OperationContext* opCtx,
Milliseconds timeoutMillis = kNoTimeout);
RemoteCommandRequest(const HostAndPort& theTarget,
const std::string& theDbName,
const BSONObj& theCmdObj,
OperationContext* opCtx,
Milliseconds timeoutMillis = kNoTimeout)
: RemoteCommandRequest(
theTarget, theDbName, theCmdObj, rpc::makeEmptyMetadata(), opCtx, timeoutMillis) {}
std::string toString() const;
bool operator==(const RemoteCommandRequest& rhs) const;
bool operator!=(const RemoteCommandRequest& rhs) const;
// Internal id of this request. Not interpreted and used for tracing purposes only.
RequestId id;
HostAndPort target;
std::string dbname;
BSONObj metadata{rpc::makeEmptyMetadata()};
BSONObj cmdObj;
// OperationContext is added to each request to allow OP_Command metadata attachment access to
// the Client object. The OperationContext is only accessed on the thread that calls
// NetworkInterface::startCommand. It is not safe to access from a thread that does not own the
// OperationContext in the general case. OperationContext should be non-null on
// NetworkInterfaces that do user work (i.e. reads, and writes) so that audit and client
// metadata is propagated. It is allowed to be null if used on NetworkInterfaces without
// metadata attachment (i.e., replication).
OperationContext* opCtx{nullptr};
Milliseconds timeout = kNoTimeout;
// Deadline by when the request must be completed
Date_t expirationDate = kNoExpirationDate;
transport::ConnectSSLMode sslMode = transport::kGlobalSSLMode;
};
std::ostream& operator<<(std::ostream& os, const RemoteCommandRequest& response);
} // namespace executor
} // namespace mongo
|
