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
117
118
119
120
121
122
123
124
125
|
/**
* 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 "mongo/bson/bsonobj.h"
#include "mongo/executor/remote_command_request.h"
namespace mongo {
class Status;
template <typename T>
class StatusWith;
struct HostAndPort;
namespace executor {
struct RemoteCommandResponse;
/**
* An hooking interface for augmenting an implementation of NetworkInterface with domain-specific
* host validation and post-connection logic.
*/
class NetworkConnectionHook {
public:
virtual ~NetworkConnectionHook() = default;
/**
* Optionally augments the isMaster request sent while initializing the wire protocol.
*
* By default this will just return the cmdObj passed in unaltered.
*/
virtual BSONObj augmentIsMasterRequest(const HostAndPort& remoteHost, BSONObj cmdObj) {
return cmdObj;
}
/**
* Runs optional validation logic on an isMaster reply from a remote host. If a non-OK
* Status is returned, it will be propagated up to the completion handler for the command
* that initiated the request that caused this connection to be created. This will
* be called once for each connection that is created, even if a remote host with the
* same HostAndPort has already successfully passed validation on a different connection.
*
* This method may be called on a different thread from the caller of startCommand that caused
* this connection to be created.
*
* This method must not throw any exceptions or block on network or disk-IO. However, in the
* event that an exception escapes, the NetworkInterface is responsible for calling
* std::terminate.
*/
virtual Status validateHost(const HostAndPort& remoteHost,
const BSONObj& isMasterRequest,
const RemoteCommandResponse& isMasterReply) = 0;
/**
* Generates a command to run on the remote host immediately after connecting to it.
* If a non-OK StatusWith is returned, it will be propagated up to the completion handler
* for the command that initiated the request that caused this connection to be created.
*
* The command will be run after socket setup, SSL handshake, authentication, and wire
* protocol detection, but before any commands submitted to the NetworkInterface via
* startCommand are run. In the case that it isn't necessary to run a command, makeRequest
* may return boost::none.
*
* This method may be called on a different thread from the caller of startCommand that caused
* this connection to be created.
*
* This method must not throw any exceptions or block on network or disk-IO. However, in the
* event that an exception escapes, the NetworkInterface is responsible for calling
* std::terminate.
*/
virtual StatusWith<boost::optional<RemoteCommandRequest>> makeRequest(
const HostAndPort& remoteHost) = 0;
/**
* Handles a remote server's reply to the command generated with makeRequest. If a
* non-OK Status is returned, it will be propagated up to the completion handler for the
* command that initiated the request that caused this connection to be created.
*
* If the corresponding earlier call to makeRequest for this connection returned
* boost::none, the NetworkInterface will not call handleReply.
*
* This method may be called on a different thread from the caller of startCommand that caused
* this connection to be created.
*
* This method must not throw any exceptions or block on network or disk-IO. However, in the
* event that an exception escapes, the NetworkInterface is responsible for calling
* std::terminate.
*/
virtual Status handleReply(const HostAndPort& remoteHost, RemoteCommandResponse&& response) = 0;
protected:
NetworkConnectionHook() = default;
};
} // namespace executor
} // namespace mongo
|
